Document http-debug-server, fixed typo in HttpServer docs.

This commit is contained in:
Jordan Bancino 2023-05-06 18:21:21 +00:00
parent 3d9a7664b1
commit bbea55be6c
3 changed files with 22 additions and 3 deletions

View file

@ -29,7 +29,7 @@ Milestone: v0.3.0
[x] Uri [x] Uri
[x] td [x] td
[x] tt [x] tt
[ ] http-debug-server [x] http-debug-server
[x] tp [x] tp
[x] send-patch [x] send-patch
[x] Log [x] Log
@ -39,7 +39,7 @@ Milestone: v0.3.0
[x] Html [x] Html
[x] Str [x] Str
[x] HeaderParser [x] HeaderParser
[ ] hdoc [ ] hdoc(1) and hdoc(5)
[x] telodendria-admin [x] telodendria-admin
[x] telodendria-setup [x] telodendria-setup
[x] telodendria-config [x] telodendria-config
@ -64,6 +64,7 @@ Milestone: v0.3.0
Milestone: v0.4.0 Milestone: v0.4.0
----------------- -----------------
[ ] Move general-purpose code to separate library
[ ] HTTP/1.1 support [ ] HTTP/1.1 support
[ ] Client-Server API [ ] Client-Server API

View file

@ -0,0 +1,18 @@
.Dd $Mdocdate: May 6 2023 $
.Dt HTTP-DEBUG-SERVER 1
.Os Telodendria Project
.Sh NAME
.Nm http-debug-server
.Nd A simple HTTP server that logs requests to the standard output.
.Sh DESCRIPTION
.Pp
.Nm
spins up an HTTP server, listening on port 8008, in the exact same
manner as Telodendria itself. Any request it receives is written to
the standard output, and an empty JSON object is returned to the
client.
.Pp
This command exists just to test the HTTP server API during
development. It probably serves no other practical purpose.
.Sh SEE ALSO
.Xr HttpServer 3

View file

@ -79,7 +79,7 @@ typedef void (HttpHandler) (HttpServerContext *, void *);
/** /**
* The number of arguments to * The number of arguments to
* .Fn HttpServerCreate * .Fn HttpServerCreate
* has grown so large that arguments are not stuffed into a * has grown so large that arguments are now stuffed into a
* configuration structure, which is in turn passed to * configuration structure, which is in turn passed to
* .Fn HttpServerCreate . * .Fn HttpServerCreate .
* This configuration is copied by value into the internal * This configuration is copied by value into the internal