Mailing List Archive

cvs commit: httpd-docs-1.3/apidoc TODO api.list mkapidict
coar 00/07/25 14:45:54

Modified: apidoc TODO api.list mkapidict
Log:
Update the TODO list, fix some typos in the api.list file, and
make sure stderr messages from mkapidict are of a fairly
consistent format.

Revision Changes Path
1.5 +229 -231 httpd-docs-1.3/apidoc/TODO

Index: TODO
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/TODO,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -u -r1.4 -r1.5
--- TODO 2000/07/25 21:04:47 1.4
+++ TODO 2000/07/25 21:45:46 1.5
@@ -1,11 +1,24 @@
-The following need the detail files written:
-ap_add_module
-ap_add_named_module
-ap_add_per_url_conf
-ap_allow_overrides
-ap_basic_http_header
-ap_bclose
-ap_bcreate
+The following need to be added to api.list:
+DEFAULT_ADMIN
+TARGET
+HTTP_VERSION
+HTTP_VERSION_MAJOR
+HTTP_VERSION_MINOR
+DEFAULT_INDEX
+DEFAULT_CONTENT_TYPE
+DEFAULT_PATH
+DEFAULT_TIMEOUT
+DEFAULT_KEEPALIVE_TIMEOUT
+DEFAULT_KEEPALIVE
+HARD_SERVER_LIMIT
+APLOG_LEVELMASK
+APLOG_WIN32ERROR
+REQUEST_NO_BODY
+REQUEST_CHUNKED_ERROR
+REQUEST_CHUNKED_DECHUNK
+REQUEST_CHUNKED_PASS
+
+The following need examples added to api.list:
ap_bfilbuf
ap_bfileno
ap_bflsbuf
@@ -13,9 +26,11 @@
ap_bgetopt
ap_bgets
ap_bhalfduplex
+ap_block_alarms
ap_blookc
ap_bnonblock
ap_bonerror
+ap_bprintf
ap_bpushfd
ap_bputs
ap_bread
@@ -24,33 +39,48 @@
ap_bskiplf
ap_bvputs
ap_bwrite
-ap_check_access
+ap_bytes_in_free_blocks
+ap_bytes_in_pool
+ap_call_exec
+ap_can_exec
+ap_cfg_closefile
+ap_cfg_getc
+ap_cfg_getline
+ap_chdir_file
+ap_checkmask
ap_check_alarm
-ap_check_auth
ap_check_cmd_context
-ap_checkmask
-ap_check_user_id
ap_child_exit_modules
ap_child_init_modules
-ap_child_terminate
+ap_cleanup_for_exec
ap_clear_module_list
+ap_clear_pool
+ap_clear_table
ap_close_piped_log
+ap_construct_server
+ap_construct_url
ap_content_type_tolower
+ap_copy_array
+ap_copy_array_hdr
+ap_copy_table
ap_core_reorder_directories
+ap_count_dirs
ap_create_environment
ap_create_per_dir_config
ap_create_request_config
ap_default_port_for_request
ap_default_port_for_scheme
ap_default_type
+ap_destroy_pool
ap_die
-ap_discard_request_body
ap_document_root
ap_each_byterange
ap_error_log2stderr
+ap_escape_html
+ap_escape_path
+ap_escape_path_segment
+ap_escape_shell_cmd
ap_exists_scoreboard_image
-ap_finalize_request_protocol
-ap_finalize_sub_req_protocol
ap_find_command
ap_find_command_in_modules
ap_find_last_token
@@ -58,177 +88,214 @@
ap_find_module_name
ap_find_path_info
ap_find_pool
-ap_find_types
+ap_find_token
ap_fini_vhost_config
ap_fnmatch
ap_force_library_loading
+ap_getparents
+ap_getword
+ap_getword_conf
+ap_getword_conf_nc
+ap_getword_nc
+ap_getword_nulls
+ap_getword_nulls_nc
+ap_getword_white
+ap_getword_white_nc
ap_get_basic_auth_pw
+ap_get_client_block
+ap_get_gmtoff
+ap_get_local_host
ap_get_module_config
ap_get_remote_host
ap_get_remote_logname
+ap_get_time
+ap_get_token
+ap_get_virthost_addr
+ap_gm_timestr_822
+ap_gname2id
ap_handle_command
-ap_header_parse
-ap_index_of_response
+ap_hard_timeout
+ap_ht_time
ap_ind
+ap_index_of_response
ap_init_alloc
ap_init_modules
ap_init_vhost_config
ap_init_virtual_host
-ap_invoke_handler
+ap_internal_redirect
+ap_internal_redirect_handler
+ap_is_directory
ap_is_fnmatch
-ap_is_initial_req
+ap_is_matchexp
+ap_is_url
+ap_keepalive_timeout
+ap_kill_cleanup
+ap_kill_cleanups_for_fd
+ap_kill_cleanups_for_socket
ap_limit_section
-APLOG_ALERT
-APLOG_CRIT
-APLOG_DEBUG
-APLOG_EMERG
-APLOG_ERR
ap_log_error
-APLOG_INFO
-APLOG_MARK
-APLOG_NOERRNO
-APLOG_NOTICE
ap_log_pid
ap_log_printf
ap_log_reason
ap_log_rerror
-ap_log_transaction
ap_log_unixerr
-APLOG_WARNING
+ap_make_array
+ap_make_dirstr
ap_make_dirstr_parent
ap_make_dirstr_prefix
+ap_make_full_path
+ap_make_sub_pool
+ap_make_table
ap_matches_request_vhost
+ap_md5
ap_md5context
ap_md5contextTo64
-AP_MD5_CTX
ap_md5digest
ap_MD5Final
-ap_md5
ap_MD5Init
ap_MD5Update
-ap_meets_conditions
ap_merge_per_dir_configs
-ap_note_auth_failure
-ap_note_basic_auth_failure
-ap_note_digest_auth_failure
+ap_no2slash
+ap_note_cleanups_for_fd
+ap_note_cleanups_for_file
+ap_note_cleanups_for_socket
+ap_note_subprocess
ap_null_cleanup
ap_open_logs
ap_open_piped_log
ap_os_is_path_absolute
+ap_overlay_tables
+ap_palloc
+ap_parseHTTPdate
ap_parse_htaccess
-ap_parse_uri_components
ap_parse_uri
+ap_parse_uri_components
ap_parse_vhost_addrs
-ap_pcfg_open_custom
+ap_pcalloc
ap_pcfg_openfile
+ap_pcfg_open_custom
ap_pclosedir
+ap_pclosef
ap_pclosesocket
ap_pduphostent
+ap_pfclose
+ap_pfdopen
+ap_pfopen
ap_pgethostbyname
ap_pool_is_ancestor
ap_pool_join
ap_popendir
+ap_popenf
+ap_pregcomp
ap_pregfree
-ap_process_request
-ap_process_resource_config
+ap_pregsub
ap_psignature
ap_psocket
+ap_pstrcat
+ap_pstrdup
+ap_pstrndup
ap_read_config
ap_read_request
+ap_register_cleanup
ap_register_other_child
-ap_remove_loaded_module
ap_remove_module
ap_requires
ap_response_code_string
ap_rfc1413
-ap_rflush
ap_rind
-ap_run_fixups
-ap_run_post_read_request
+ap_rprintf
+ap_rputc
+ap_rputs
+ap_run_cleanup
+ap_rvputs
ap_rwrite
-ap_satisfies
-ap_scan_script_header_err_buff
ap_scan_script_header_err
+ap_scan_script_header_err_buff
ap_send_error_response
+ap_send_fb
+ap_send_fb_length
+ap_send_fd
+ap_send_fd_length
ap_send_header_field
-ap_send_http_options
-ap_send_http_trace
ap_send_mmap
ap_send_size
ap_server_root_relative
-ap_set_byterange
+ap_setup_client_block
ap_set_callback_and_alarm
ap_set_content_length
-ap_set_etag
ap_set_file_slot
ap_set_flag_slot
-ap_set_keepalive
-ap_set_last_modified
ap_set_module_config
ap_set_name_virtual_host
ap_set_string_slot
ap_set_string_slot_lower
ap_set_sub_req_protocol
-ap_setup_prelinked_modules
-ap_show_directives
-ap_show_modules
-ap_some_auth_required
+ap_soft_timeout
+ap_spawn_child_err
+ap_spawn_child_err_buff
ap_srm_command_loop
ap_start_restart
-ap_start_shutdown
+ap_strcasecmp_match
+ap_strcmp_match
ap_str_tolower
-ap_sync_scoreboard_image
+ap_sub_req_lookup_file
+ap_sub_req_lookup_uri
+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
ap_time_process_request
-ap_translate_name
+ap_tm2sec
+ap_uname2id
+ap_unblock_alarms
+ap_unescape_url
ap_unparse_uri_components
ap_unregister_other_child
ap_update_child_status
ap_update_mtime
-ap_update_vhost_from_headers
ap_update_vhost_given_ip
-ap_util_init
-ap_util_uri_init
-ap_validate_password
-ap_vformatter_buff
+ap_uudecode
+ap_vbprintf
ap_vformatter
-ap_wait_t
-array_header
+ap_vformatter_buff
BUFF
+cmd_parms
command_rec
configfile_t
-DECLINE_CMD
-M_COPY
-M_LOCK
-M_MKCOL
-M_MOVE
-M_PATCH
-M_PROPFIND
-M_UNLOCK
-OPT_ALL
-OPT_EXECCGI
-OPT_INCLUDES
-OPT_INCNOEXEC
-OPT_INDEXES
-OPT_MULTI
-OPT_NONE
-OPT_SYM_LINKS
-OPT_SYM_OWNER
-OPT_UNSET
+conn_rec
OS_ASC
piped_log
proxyreqtype
regex_t
regmatch_t
+request_rec
scoreboard
server_addr_rec
+server_rec
short_score
uri_components

-The following need examples added to api.list:
-ap_add_per_dir_conf
-ap_append_arrays
-ap_array_cat
+The following need the detail files written:
+APLOG_ALERT
+APLOG_CRIT
+APLOG_DEBUG
+APLOG_EMERG
+APLOG_ERR
+APLOG_INFO
+APLOG_MARK
+APLOG_NOERRNO
+APLOG_NOTICE
+APLOG_WARNING
+ap_add_module
+ap_add_named_module
+ap_add_per_url_conf
+ap_allow_overrides
+ap_basic_http_header
ap_bclose
ap_bcreate
ap_bfilbuf
@@ -238,11 +305,9 @@
ap_bgetopt
ap_bgets
ap_bhalfduplex
-ap_block_alarms
ap_blookc
ap_bnonblock
ap_bonerror
-ap_bprintf
ap_bpushfd
ap_bputs
ap_bread
@@ -251,48 +316,34 @@
ap_bskiplf
ap_bvputs
ap_bwrite
-ap_bytes_in_free_blocks
-ap_bytes_in_pool
-ap_call_exec
-ap_can_exec
-ap_cfg_closefile
-ap_cfg_getc
-ap_cfg_getline
-ap_chdir_file
+ap_checkmask
+ap_check_access
ap_check_alarm
+ap_check_auth
ap_check_cmd_context
-ap_checkmask
+ap_check_user_id
ap_child_exit_modules
ap_child_init_modules
-ap_cleanup_for_exec
+ap_child_terminate
ap_clear_module_list
-ap_clear_pool
-ap_clear_table
ap_close_piped_log
-ap_construct_server
-ap_construct_url
ap_content_type_tolower
-ap_copy_array
-ap_copy_array_hdr
-ap_copy_table
ap_core_reorder_directories
-ap_count_dirs
ap_create_environment
ap_create_per_dir_config
ap_create_request_config
ap_default_port_for_request
ap_default_port_for_scheme
ap_default_type
-ap_destroy_pool
ap_die
+ap_discard_request_body
ap_document_root
ap_each_byterange
ap_error_log2stderr
-ap_escape_html
-ap_escape_path
-ap_escape_path_segment
-ap_escape_shell_cmd
ap_exists_scoreboard_image
+ap_field_noparam
+ap_finalize_request_protocol
+ap_finalize_sub_req_protocol
ap_find_command
ap_find_command_in_modules
ap_find_last_token
@@ -300,64 +351,35 @@
ap_find_module_name
ap_find_path_info
ap_find_pool
-ap_find_token
+ap_find_types
ap_fini_vhost_config
ap_fnmatch
ap_force_library_loading
ap_get_basic_auth_pw
-ap_get_client_block
-ap_get_gmtoff
-ap_get_local_host
ap_get_module_config
-ap_getparents
ap_get_remote_host
ap_get_remote_logname
-ap_get_time
-ap_get_token
-ap_get_virthost_addr
-ap_getword
-ap_getword_conf
-ap_getword_conf_nc
-ap_getword_nc
-ap_getword_nulls
-ap_getword_nulls_nc
-ap_getword_white
-ap_getword_white_nc
-ap_gm_timestr_822
-ap_gname2id
ap_handle_command
-ap_hard_timeout
-ap_ht_time
+ap_header_parse
ap_ind
ap_index_of_response
ap_init_alloc
ap_init_modules
ap_init_vhost_config
ap_init_virtual_host
-ap_internal_redirect
-ap_internal_redirect_handler
-ap_is_directory
+ap_invoke_handler
ap_is_fnmatch
-ap_is_matchexp
-ap_is_url
-ap_keepalive_timeout
-ap_kill_cleanup
-ap_kill_cleanups_for_fd
-ap_kill_cleanups_for_socket
+ap_is_initial_req
ap_limit_section
ap_log_error
ap_log_pid
ap_log_printf
ap_log_reason
ap_log_rerror
+ap_log_transaction
ap_log_unixerr
-ap_make_array
-ap_make_dirstr
ap_make_dirstr_parent
ap_make_dirstr_prefix
-ap_make_full_path
-ap_make_sub_pool
-ap_make_table
ap_matches_request_vhost
ap_md5
ap_md5context
@@ -366,154 +388,130 @@
ap_MD5Final
ap_MD5Init
ap_MD5Update
+AP_MD5_CTX
+ap_meets_conditions
ap_merge_per_dir_configs
-ap_no2slash
-ap_note_cleanups_for_fd
-ap_note_cleanups_for_file
-ap_note_cleanups_for_socket
-ap_note_subprocess
+ap_note_auth_failure
+ap_note_basic_auth_failure
+ap_note_digest_auth_failure
ap_null_cleanup
ap_open_logs
ap_open_piped_log
ap_os_is_path_absolute
-ap_overlay_tables
-ap_palloc
ap_parse_htaccess
-ap_parseHTTPdate
ap_parse_uri
ap_parse_uri_components
ap_parse_vhost_addrs
-ap_pcalloc
-ap_pcfg_open_custom
ap_pcfg_openfile
+ap_pcfg_open_custom
ap_pclosedir
-ap_pclosef
ap_pclosesocket
ap_pduphostent
-ap_pfclose
-ap_pfdopen
-ap_pfopen
ap_pgethostbyname
ap_pool_is_ancestor
ap_pool_join
ap_popendir
-ap_popenf
-ap_pregcomp
ap_pregfree
-ap_pregsub
+ap_process_request
+ap_process_resource_config
ap_psignature
ap_psocket
-ap_pstrcat
-ap_pstrdup
-ap_pstrndup
ap_read_config
ap_read_request
-ap_register_cleanup
ap_register_other_child
+ap_remove_loaded_module
ap_remove_module
ap_requires
ap_response_code_string
ap_rfc1413
+ap_rflush
ap_rind
-ap_rprintf
-ap_rputc
-ap_rputs
-ap_run_cleanup
-ap_rvputs
+ap_run_fixups
+ap_run_post_read_request
ap_rwrite
+ap_satisfies
ap_scan_script_header_err
ap_scan_script_header_err_buff
ap_send_error_response
-ap_send_fb
-ap_send_fb_length
-ap_send_fd
-ap_send_fd_length
ap_send_header_field
+ap_send_http_options
+ap_send_http_trace
ap_send_mmap
ap_send_size
ap_server_root_relative
+ap_setup_prelinked_modules
+ap_set_byterange
ap_set_callback_and_alarm
ap_set_content_length
+ap_set_etag
ap_set_file_slot
ap_set_flag_slot
+ap_set_keepalive
+ap_set_last_modified
ap_set_module_config
ap_set_name_virtual_host
ap_set_string_slot
ap_set_string_slot_lower
ap_set_sub_req_protocol
-ap_setup_client_block
-ap_soft_timeout
-ap_spawn_child_err
-ap_spawn_child_err_buff
+ap_show_directives
+ap_show_modules
+ap_some_auth_required
ap_srm_command_loop
ap_start_restart
-ap_strcasecmp_match
-ap_strcmp_match
+ap_start_shutdown
ap_str_tolower
-ap_sub_req_lookup_file
-ap_sub_req_lookup_uri
-ap_table_add
-ap_table_addn
+ap_sync_scoreboard_image
ap_table_do
-ap_table_get
-ap_table_merge
-ap_table_mergen
-ap_table_set
-ap_table_setn
-ap_table_unset
ap_time_process_request
-ap_tm2sec
-ap_uname2id
-ap_unblock_alarms
-ap_unescape_url
+ap_translate_name
ap_unparse_uri_components
ap_unregister_other_child
ap_update_child_status
ap_update_mtime
+ap_update_vhost_from_headers
ap_update_vhost_given_ip
-ap_uudecode
-ap_vbprintf
+ap_util_init
+ap_util_uri_init
+ap_validate_password
ap_vformatter
ap_vformatter_buff
+ap_wait_t
+array_header
BUFF
-cmd_parms
command_rec
configfile_t
-conn_rec
+DECLINE_CMD
+HTTP_EXPECTATION_FAILED
+HTTP_FAILED_DEPENDENCY
+HTTP_INSUFFICIENT_STORAGE
+HTTP_LOCKED
+HTTP_NOT_EXTENDED
+HTTP_PROCESSING
+HTTP_RANGE_NOT_SATISFIABLE
+HTTP_UNPROCESSABLE_ENTITY
+M_COPY
+M_LOCK
+M_MKCOL
+M_MOVE
+M_PATCH
+M_PROPFIND
+M_UNLOCK
+OPT_ALL
+OPT_EXECCGI
+OPT_INCLUDES
+OPT_INCNOEXEC
+OPT_INDEXES
+OPT_MULTI
+OPT_NONE
+OPT_SYM_LINKS
+OPT_SYM_OWNER
+OPT_UNSET
OS_ASC
piped_log
proxyreqtype
regex_t
regmatch_t
-request_rec
scoreboard
server_addr_rec
-server_rec
short_score
uri_components
-
-The following need to be added to api.list:
-DEFAULT_ADMIN
-TARGET
-HTTP_VERSION
-HTTP_VERSION_MAJOR
-HTTP_VERSION_MINOR
-DEFAULT_INDEX
-DEFAULT_CONTENT_TYPE
-DEFAULT_PATH
-DEFAULT_TIMEOUT
-DEFAULT_KEEPALIVE_TIMEOUT
-DEFAULT_KEEPALIVE
-HARD_SERVER_LIMIT
-APLOG_LEVELMASK
-APLOG_WIN32ERROR
-ap_is_HTTP_INFO
-ap_is_HTTP_SUCCESS
-ap_is_HTTP_REDIRECT
-ap_is_HTTP_ERROR
-ap_is_HTTP_CLIENT_ERROR
-ap_is_HTTP_SERVER_ERROR
-REQUEST_NO_BODY
-REQUEST_CHUNKED_ERROR
-REQUEST_CHUNKED_DECHUNK
-REQUEST_CHUNKED_PASS



1.21 +7 -7 httpd-docs-1.3/apidoc/api.list

Index: api.list
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/api.list,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -u -r1.20 -r1.21
--- api.list 2000/07/25 21:04:47 1.20
+++ api.list 2000/07/25 21:45:47 1.21
@@ -91,7 +91,7 @@
|char *$*(pool *p, const char *intype);\
|content_type = $*(r->pool, r->content_type);\
|\
- !dict-$*.html
+ |dict-$*.html
R|ap_add_version_component\
|void $*(const char *component);\
|/*\n * Called during modules-init phase\n */\n$*("MyMod/1.0");\
@@ -1094,7 +1094,7 @@
|dict-$*.html
R|ap_array_cat\
|void $*(array_header *dst, const array_header *src);\
- |\
+ |$*(&res->a, &base->second);\
|SA-array\
|dict-$*.html
R|ap_copy_array\
@@ -1274,7 +1274,7 @@
#;
R|ap_append_arrays\
|array_header *$*(pool *p, const array_header *a, const array_header *b);\
- |\
+ |new->hdr_list = $*(p, add->hdr_list, base->hdr_list);\
|SA-array\
|dict-$*.html
R|ap_pregsub\
@@ -1513,8 +1513,8 @@
|dict-$*.html
R|ap_add_per_dir_conf\
|void $*(server_rec *s, void *dir_config);\
+ |<i>Private to the Apache core server; not for module use.</i>\
|\
- |\
|dict-$*.html
R|ap_cpystrn\
|char *$*(char *buf, const char *str, size_t numbytes);\
@@ -1629,12 +1629,12 @@
|dict-$*.html
R|ap_bclose\
|int $*(BUFF *fb);\
- |\
+ |status = $*(r-&gt;connection-&gt;client);\
|\
|dict-$*.html
R|ap_bcreate\
|BUFF *$*(pool *p, int flags);\
- |\
+ |c-&gt;fp = $*(p, B_RDWR &#124; B_SOCKET);\
|\
|dict-$*.html
R|ap_bfilbuf\
@@ -3017,7 +3017,7 @@
X|SA-httpcodes\
|ap_status_drops_connection,ap_is_HTTP_INFO,ap_is_HTTP_SUCCESS\
,ap_is_HTTP_REDIRECT,ap_is_HTTP_ERROR,ap_is_HTTP_CLIENT_ERROR\
- ,ap_is_HTTP_SERVER_ERROR\HTTP_CONTINUE,HTTP_SWITCHING_PROTOCOLS\
+ ,ap_is_HTTP_SERVER_ERROR,HTTP_CONTINUE,HTTP_SWITCHING_PROTOCOLS\
,HTTP_OK,HTTP_CREATED,HTTP_ACCEPTED,HTTP_NON_AUTHORITATIVE\
,HTTP_NO_CONTENT,HTTP_RESET_CONTENT,HTTP_PARTIAL_CONTENT\
,HTTP_MULTIPLE_CHOICES,HTTP_MOVED_PERMANENTLY,HTTP_MOVED_TEMPORARILY\



1.14 +5 -5 httpd-docs-1.3/apidoc/mkapidict

Index: mkapidict
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/mkapidict,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -u -r1.13 -r1.14
--- mkapidict 2000/07/25 21:04:48 1.13
+++ mkapidict 2000/07/25 21:45:47 1.14
@@ -188,17 +188,17 @@
else {
$dir = "many";
}
- print STDERR "Too $dir fields (", ($#field + 1), " instead of 6) "
+ print STDERR "$0: Too $dir fields (", ($#field + 1), " instead of 6) "
. "for record $RecordNum at line $DataLine\n";
}
if ($field[0] !~ m:^[RMSCDX]$:i) {
- print STDERR "Unrecognised record identifier /$field[0]/ ",
+ print STDERR "$0: Unrecognised record identifier /$field[0]/ ",
"for record ending on line $DataLine;\n",
"\tmissing continuation character?\n";
next;
}
if ($Entity{$field[1]}) {
- print STDERR "Entity $field[1] redefined at line $DataLine.\n";
+ print STDERR "$0: Entity $field[1] redefined at line $DataLine.\n";
}
$Entity{$field[1]} = 1;
$rtype = uc(substr($field[0], 0, 1));
@@ -591,8 +591,8 @@
$item = "<a href=\"$uri\">$item</a>";
}
else {
- print STDERR "$iname cross-references to undefined ";
- print STDERR "entity $_.\n";
+ print STDERR "$0: undefined cross-reference: "
+ . "$iname references undefined entity $_.\n";
}
$ref_list .= $item . ",\n ";
}