Return-Path: Delivered-To: apache-cvs-archive@hyperreal.org Received: (qmail 22539 invoked by uid 6000); 3 May 1998 20:20:16 -0000 Received: (qmail 22533 invoked by alias); 3 May 1998 20:20:15 -0000 Delivered-To: apache-devsite-cvs@hyperreal.org Received: (qmail 22529 invoked by uid 161); 3 May 1998 20:20:14 -0000 Date: 3 May 1998 20:20:14 -0000 Message-ID: <19980503202014.22528.qmail@hyperreal.org> From: coar@hyperreal.org To: apache-devsite-cvs@hyperreal.org Subject: cvs commit: apache-devsite/apidoc api.list mkapidict Sender: apache-cvs-owner@apache.org Precedence: bulk Reply-To: new-httpd@apache.org coar 98/05/03 13:20:14 Modified: apidoc api.list mkapidict Log: Argh. Forgot to commit a change to how X-records should be structured. Fixed.. Revision Changes Path 1.2 +34 -32 apache-devsite/apidoc/api.list Index: api.list =================================================================== RCS file: /export/home/cvs/apache-devsite/apidoc/api.list,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- api.list 1998/05/03 19:45:56 1.1 +++ api.list 1998/05/03 20:20:13 1.2 @@ -1,5 +1,5 @@ #; -#; Metadata about API components. Each line contains several fields, +#; Metadata about API components. Each record contains several fields, #; separated by vbars (|). Comments begin with '#;' and continue #; to the end of the line. Leading whitespace is discarded except as #; noted below. Continuation is indicated by a '\' as the last @@ -13,7 +13,7 @@ #; provides for indentation of continuation text (as in a structure #; definition). #; -#; By convention the '|' field delimiter appears on same line as the +#; By convention the '|' field delimiter appears on the same line as the #; field that *follows* it. #; #; Each record looks like: @@ -25,34 +25,36 @@ #; S structure/datatype #; C constant #; D global data cell -#; X name for a list of cross-references (usable in the see-also field) +#; X alias for a list of cross-references (usable in the see-also field) #; #; see-also is a comma-separated list of other names in this file. If -#; the current entity-name appears in the list, it's ignored. +#; the current entity-name appears in the list, it's ignored. If +#; the name of an 'X' alias appears in the see-also list, it will be +#; expanded before the list is scanned for the current entity name. #; desc-file is the name of a file (relative to the cwd) containing an HTML #; description for the component. Not used for 'X' records. #; #; HTML markup is permitted in all fields except type and name. #; #; Due to '|' being used as the field delimiter, vbars must be represented -#; as '|'. +#; as '|'. #; #; Due to the interpretation of text as HTML, all ampersands ('&') must be -#; escaped as '&'. +#; escaped as '&'. #; #; The special tag '$*' will be replaced wherever it occurs in a record -#; with the name of the entity being defined +#; with the name of the entity being defined. #; #; #; Symbols related to how the server identifies itself #; X|SA-identity\ - |\ #; Definition - |\ #; Examples |ap_get_server_built,ap_get_server_name,ap_get_server_version\ + |\ + |\ | R|ap_get_server_built\ - |char *$*(void);\ #; Definition + |char *$*(void);\ #; Definition |char *string;\nstring = $*();\ #; Examples |SA-identity\ #; Cross-references | #; Entity documention HTML file @@ -70,9 +72,9 @@ #; Stuff related to the module structure #; X|SA-module\ + |core_module,top_module,module,ap_add_module,ap_add_named_module\ |\ |\ - |core_module,top_module,module,ap_add_module,ap_add_named_module\ | S|module\ #; Since this is a multi-line structure, beware when editing |typedef struct module_struct { \n \ @@ -198,10 +200,10 @@ #; MD5 digesting functions #; X|SA-md5\ - |\ - |\ |AP_MD5_CTX,ap_md5,ap_md5context,ap_md5digest,ap_MD5Final\ ,ap_MD5Init,ap_MD5Update,ap_md5contextTo64\ + |\ + |\ | S|AP_MD5_CTX\ |This is an opaque structure; you don't need to access any of its \ @@ -249,10 +251,10 @@ #; Mutex routines #; X|SA-mutex\ - |\ - |\ |mutex,ap_acquire_mutex,ap_create_mutex,ap_destroy_mutex\ ,ap_open_mutex\ + |\ + |\ | S|mutex\ |This is an opaque structure; you don't need to access any of its \ @@ -284,14 +286,14 @@ #; Stuff for the scoreboard #; X|SA-scoreboard\ - |\ - |\ |scoreboard,SERVER_DEAD,SERVER_STARTING,SERVER_READY\ ,SERVER_BUSY_READ,SERVER_BUSY_WRITE,SERVER_BUSY_KEEPALIVE\ ,SERVER_BUSY_LOG,SERVER_BUSY_DNS,SERVER_GRACEFUL,SERVER_NUM_STATUS\ ,vtime_t,short_score,global_score,parent_score,START_PREQUEST\ ,STOP_PREQUEST,ap_sync_scoreboard_image,ap_exists_scoreboard_image\ ,ap_scoreboard_image\ + |\ + |\ | C|SERVER_DEAD\ |#define $* value\ @@ -457,9 +459,9 @@ #; Reliable piped log stuff #; X|SA-piped-log\ + |piped_log,ap_close_piped_log,ap_open_piped_log\ |\ |\ - |piped_log,ap_close_piped_log,ap_open_piped_log\ | S|piped_log\ |typedef struct piped_log { \n \ @@ -649,10 +651,10 @@ #; Directive overrides #; X|SA-overrides\ - |\ - |\ |ACCESS_CONF,OR_AUTHCFG,OR_FILEINFO,OR_INDEXES,OR_LIMIT\ ,OR_OPTIONS,RSRC_CONF\ + |\ + |\ | C|RSRC_CONF\ |#define $* value\ @@ -693,12 +695,12 @@ #; Tables.. #; X|SA-tables\ - |\ - |\ |table,ap_clear_table,ap_copy_table,ap_make_table\ ,ap_overlay_tables,ap_table_add,ap_table_addn,ap_table_do\ ,ap_table_get,ap_table_merge,ap_table_mergen,ap_table_set\ ,ap_table_setn,ap_table_unset\ + |\ + |\ | S|table\ |typedef struct $* {opaque-structure};\ @@ -778,10 +780,10 @@ #; Arrays.. #; X|SA-array\ - |\ - |\ |array_header,ap_array_cat,ap_append_arrays,ap_copy_array\ ,ap_copy_array_hdr,ap_make_array,ap_push_array\ + |\ + |\ | S|array_header\ |typedef struct { \n \ @@ -823,13 +825,13 @@ #; Now the items relating to pools #; X|SA-pool\ - |\ - |\ |pool,ap_bytes_in_pool,ap_clear_pool,ap_destroy_pool,ap_find_pool\ ,ap_pool_is_ancestor,ap_pool_join,ap_make_sub_pool,ap_pstrcat,ap_palloc\ ,ap_pcalloc,ap_pclosedir,ap_pclosef,ap_pclosesocket,ap_pduphostent\ ,ap_pfclose,ap_pfdopen,ap_pfopen,ap_pgethostbyname,ap_popendir\ ,ap_popenf,ap_pregcomp,ap_pregfree,ap_psocket,ap_pstrdup,ap_pstrndup\ + |\ + |\ | S|pool\ |[struct] pool opaque-structure\ @@ -1015,10 +1017,10 @@ |\ | X|SA-dirdata\ - |\ - |\ |cmd_how,RAW_ARGS,TAKE1,TAKE2,ITERATE,ITERATE2,FLAG,NO_ARGS,TAKE12\ ,TAKE3,TAKE23,TAKE123,TAKE13\ + |\ + |\ | C|cmd_how\ |enum cmd_how { \n \ @@ -2483,9 +2485,9 @@ #; elsewhere. #; X|SA-dirstat\ + |OK,DECLINED,DONE\ |\ |\ - |OK,DECLINED,DONE\ | C|OK\ |#define $* value\ @@ -2700,11 +2702,11 @@ #; so that's how we list them. #; X|SA-status-check\ - |\ - |\ |is_HTTP_INFO,is_HTTP_SUCCESS,is_HTTP_REDIRECT\ ,is_HTTP_ERROR,is_HTTP_CLIENT_ERROR,is_HTTP_SERVER_ERROR\ ,status_drops_connection\ + |\ + |\ | R|is_HTTP_INFO\ |#define $*(x) (((x) >= 100) && ((x) < 200))\ @@ -2753,9 +2755,9 @@ |SA-status-check\ | X|SA-methods\ + |M_GET,M_PUT,M_POST,M_DELETE,M_CONNECT,M_OPTIONS,M_TRACE,M_INVALID\ |\ |\ - |M_GET,M_PUT,M_POST,M_DELETE,M_CONNECT,M_OPTIONS,M_TRACE,M_INVALID\ | C|M_GET\ |#define $* value\ 1.2 +1 -1 apache-devsite/apidoc/mkapidict Index: mkapidict =================================================================== RCS file: /export/home/cvs/apache-devsite/apidoc/mkapidict,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- mkapidict 1998/05/03 20:00:23 1.1 +++ mkapidict 1998/05/03 20:20:13 1.2 @@ -89,7 +89,7 @@ } elsif ($field[0] =~ /D/i) { $Cell{$field[1]} = $rec; } elsif ($field[0] =~ /X/i) { - $SeeAlso{$field[1]} = $field[4]; + $SeeAlso{$field[1]} = $field[2]; }; };