Mailing List Archive

coar 00/07/25 06:03:50

Modified: apidoc api.list dict-ap_send_http_header.html mkapidict
Log:
Update a little docco, and make the script distinguish between
routines and macros that look like routines.

Revision Changes Path
1.19 +9 -8 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.18
retrieving revision 1.19
diff -u -u -r1.18 -r1.19
--- api.list 2000/07/25 03:37:05 1.18
+++ api.list 2000/07/25 13:03:44 1.19
@@ -22,6 +22,7 @@
#;
#; where type is one of
#; R API routine
+#; M Macro that looks like a routine call
#; S structure/datatype
#; C constant
#; D global data cell
@@ -2896,7 +2897,7 @@
|entity = strstr(request, CRLF CRLF) + (2 * strlen(CRLF));\
|SA-stringconst\
|dict-$*.html
-R|OS_ASC\
+M|OS_ASC\
|#ifndef CHARSET_EBCDIC \n \
#define $*(c) (c) \n \
#else \n \
@@ -3251,42 +3252,42 @@
|\
|\
|
-R|is_HTTP_INFO\
+M|is_HTTP_INFO\
|#define $*(x) (((x) >= 100) && ((x) < 200))\
|request_rec *r;\nif (!$*(r->status)) { \n \
return OK; \n \
} \
|SA-status-check\
|dict-$*.html
-R|is_HTTP_SUCCESS\
+M|is_HTTP_SUCCESS\
|#define $*(x) (((x) >= 200) && ((x) < 300))\
|request_rec *r;\nif (!$*(r->status)) { \n \
return OK; \n \
} \
|SA-status-check\
|dict-$*.html
-R|is_HTTP_REDIRECT\
+M|is_HTTP_REDIRECT\
|#define $*(x) (((x) >= 300) && ((x) < 400))\
|request_rec *r;\nif (!$*(r->status)) { \n \
return OK; \n \
} \
|SA-status-check\
|dict-$*.html
-R|is_HTTP_ERROR\
+M|is_HTTP_ERROR\
|#define $*(x) (((x) >= 400) && ((x) < 600))\
|request_rec *r;\nif (!$*(r->status)) { \n \
return DONE; \n \
} \
|SA-status-check\
|dict-$*.html
-R|is_HTTP_CLIENT_ERROR\
+M|is_HTTP_CLIENT_ERROR\
|#define $*(x) (((x) >= 400) && ((x) < 500))\
|request_rec *r;\nif (!$*(r->status)) { \n \
return DONE; \n \
} \
|SA-status-check\
|dict-$*.html
-R|is_HTTP_SERVER_ERROR\
+M|is_HTTP_SERVER_ERROR\
|#define $*(x) (((x) >= 500) && ((x) < 600))\
|request_rec *r;\nif (!$*(r->status)) { \n \
return DONE; \n \
@@ -3297,7 +3298,7 @@
#; This is another messy definition; the spacing has to be done
#; correctly for horizontal alignment in the final <PRE> block.
#;
-R|status_drops_connection\
+M|status_drops_connection\
|#define $*(x) (((x) == HTTP_BAD_REQUEST) &#124;&#124;\n\
((x) == HTTP_REQUEST_TIME_OUT) &#124;&#124;\n\
((x) == HTTP_LENGTH_REQUIRED) &#124;&#124;\n\



1.4 +10 -3 httpd-docs-1.3/apidoc/dict-ap_send_http_header.html

Index: dict-ap_send_http_header.html
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/dict-ap_send_http_header.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -u -r1.3 -r1.4
--- dict-ap_send_http_header.html 2000/07/24 22:13:59 1.3
+++ dict-ap_send_http_header.html 2000/07/25 13:03:45 1.4
@@ -1,5 +1,12 @@
<p>
-Sends HTTP headers to the client from <EM>r-&gt;headers_out</EM>. Additional
-HTTP headers may be sent by the server, depending on HTTP protocol version.
-This must be called in a request handler before sending content.
+Sends the accumulated HTTP header fields to the client from
+<code>r-&gt;headers_out</code> and <code>r-&gt;err_headers_out</code>.
+Additional HTTP header fields may be added by the server, depending on
+HTTP protocol version.
+</p>
+<p>
+This must be called by content handlers before they send any actual
+content. Once this routine has been called, further changes to the
+<code>r-&gt;headers_out</code> and <code>r-&gt;err_headers_out</code>
+tables are ignored.
</p>



1.12 +15 -8 httpd-docs-1.3/apidoc/mkapidict

Index: mkapidict
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/apidoc/mkapidict,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -u -r1.11 -r1.12
--- mkapidict 2000/07/24 11:50:28 1.11
+++ mkapidict 2000/07/25 13:03:46 1.12
@@ -69,6 +69,7 @@

$command_line = join(" ", $0, @ARGV);
%Prefix = ('R' => 'Routine',
+ 'M' => 'Macro',
'C' => 'Constant',
'S' => 'Structure',
'D' => 'Global Data Cell');
@@ -190,7 +191,7 @@
print STDERR "Too $dir fields (", ($#field + 1), " instead of 6) "
. "for record $RecordNum at line $DataLine\n";
}
- if ($field[0] !~ m:^[RSCDX]$:i) {
+ if ($field[0] !~ m:^[RMSCDX]$:i) {
print STDERR "Unrecognised record identifier /$field[0]/ ",
"for record ending on line $DataLine;\n",
"\tmissing continuation character?\n";
@@ -201,7 +202,7 @@
}
$Entity{$field[1]} = 1;
$rtype = uc(substr($field[0], 0, 1));
- if ($rtype eq 'R') {
+ if ($rtype =~ /M|R/) {
$Routine{$field[1]} = $rec;
}
elsif ($rtype eq 'S') {
@@ -454,10 +455,11 @@

sub dump_item {
my ($ofh, $prefix, $key, $record, $previous, $next) = @_;
- my ($edited, $iname, $idef, $isamp, $iref, $idesc) =
+ my ($rtype, $iname, $idef, $isamp, $iref, $idesc) =
split(m:\|:, $record);
my ($uri) = $URL{"$iname"};
my ($href) = $HREF{"$iname"};
+ my ($edited);

print $ofh <<EOHT if ($Layout == 0);
<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN"
@@ -468,15 +470,20 @@
</head>
<body>
<h1>Apache API Documentation</h1>
- <h3>$iname</h3>
EOHT

- if ($Layout > 0) {
- my($p) = $Prefix{$prefix};
- print $ofh <<EOHT
+ my($p) = $Prefix{$rtype};
+ if ($Layout == 0) {
+ print $ofh <<EOHT;
+ <h3>$p $iname</h3>
+EOHT
+ }
+ else {
+ print <<EOHT;
<h3><a name="$uri">$p $iname</a></h3>
EOHT
-}
+ }
+
$edited = &edit_inline($idef, $iname);
if (! $edited) {
$edited = "No prototype or definition available.";