From b4a394c44b85f46463385621847c54158bcad490 Mon Sep 17 00:00:00 2001 From: Jordan Bancino Date: Fri, 10 Mar 2023 23:02:09 +0000 Subject: [PATCH] Move send-patch and td to section one of the manual. I think they fit there better. --- man/{man8/send-patch.8 => man1/send-patch.1} | 17 +-- man/{man8/td.8 => man1/td.1} | 4 +- man/man7/porting.7 | 6 +- man/man7/telodendria-changelog.7 | 103 +++++++++++++++++-- man/man7/telodendria-contributing.7 | 8 +- man/man7/telodendria.7 | 4 +- 6 files changed, 118 insertions(+), 24 deletions(-) rename man/{man8/send-patch.8 => man1/send-patch.1} (86%) rename man/{man8/td.8 => man1/td.1} (99%) diff --git a/man/man8/send-patch.8 b/man/man1/send-patch.1 similarity index 86% rename from man/man8/send-patch.8 rename to man/man1/send-patch.1 index e1b4fff..50c9d5a 100644 --- a/man/man8/send-patch.8 +++ b/man/man1/send-patch.1 @@ -1,5 +1,5 @@ -.Dd $Mdocdate: November 27 2022 $ -.Dt SEND-PATCH 8 +.Dd $Mdocdate: March 10 2023 $ +.Dt SEND-PATCH 1 .Os Telodendria Project .Sh NAME .Nm send-patch @@ -11,11 +11,14 @@ .Nm is a simple shell script for submitting patch files to Telodendria's patch room for review. Do note that it depends on -.Xr jq 1 +.Xr json 1 and .Xr curl 1 , -and so may not work out of the box on some systems. However, these tools are -readily available for most systems. Please consult your package manager's +and so may not work out of the box on some systems. However, +.Xr json 1 +ships with Telodendria, and +.Xr curl 1 +is readily available for most systems. Please consult your package manager's manual for installing packages. .Pp .Nm @@ -54,10 +57,10 @@ password authentication flow. does utilize the .Pa .env file, just like -.Xr td 8 . +.Xr td 1 . Consult that page for the specifics of the .Pa .env file. .Sh SEE ALSO -.Xr td 8 +.Xr td 1 diff --git a/man/man8/td.8 b/man/man1/td.1 similarity index 99% rename from man/man8/td.8 rename to man/man1/td.1 index 3d136be..7cba3b0 100644 --- a/man/man8/td.8 +++ b/man/man1/td.1 @@ -1,5 +1,5 @@ -.Dd $Mdocdate: February 15 2023 $ -.Dt TD 8 +.Dd $Mdocdate: March 10 2023 $ +.Dt TD 1 .Os Telodendria Project .Sh NAME .Nm td diff --git a/man/man7/porting.7 b/man/man7/porting.7 index 81a4273..fc274b9 100644 --- a/man/man7/porting.7 +++ b/man/man7/porting.7 @@ -1,4 +1,4 @@ -.Dd $Mdocdate: November 20 2022 $ +.Dd $Mdocdate: March 10 2023 $ .Dt PORTING 7 .Os Telodendria Project .Sh NAME @@ -23,7 +23,7 @@ That being said, this page aims to assist those who want to package Telodendria for their operating system or software distribution. .Pp See -.Xr td 8 +.Xr td 1 for instructions on how to build Telodendria. Only proceed with packaging Telodendria after you have successfully built it on your operating system. .Pp @@ -155,5 +155,5 @@ OpenBSD port. .Pp .Sh SEE ALSO .Xr telodendria-contributing 7 , -.Xr td 8 , +.Xr td 1 , .Xr telodendria 7 diff --git a/man/man7/telodendria-changelog.7 b/man/man7/telodendria-changelog.7 index 0f0bfd4..0c2e5f4 100644 --- a/man/man7/telodendria-changelog.7 +++ b/man/man7/telodendria-changelog.7 @@ -1,4 +1,4 @@ -.Dd $Mdocdate: March 8 2023 $ +.Dd $Mdocdate: March 10 2023 $ .Dt TELODENDRIA-CHANGELOG 7 .Os Telodendria Project .Sh NAME @@ -38,13 +38,104 @@ support, an HTTP client, and more! The third major release of packs a lot of general improvements on top of supporting more of the Matrix specification. .Pp +Matrix Specification: .Bl -bullet .It -Added a simple HTTP client API, which will be used for federation. -This release also ships with a simple command line tool similar to +Added support for the +.Pa /_matrix/client/v3/account/whoami +endpoint. +.El +.Pp +New Features: +.Bl -bullet +.It +Added a new +.Xr HttpClient 3 +API for making HTTP requests. This will eventually be used for +federating with other Matrix homeservers. +.It +Added support for pretty-printing JSON to +.Xr Json 3 . +.Nm +itself doesn't pretty-print JSON, but this is useful for debugging +and building useful tools. +.It +Added a handful of useful development tools built on the +.Nm +APIs. New tools include +.Xr http 1 , +a command line tool for making HTTP requests, similar to +.Xr curl 1 , +.Xr json 1 , +a command line tool for working with JSON, similar to +.Xr jq 1 , +and +.Xr http-debug-server 1 , +a simple HTTP server that just prints requests out to standard +output and returns an empty JSON object. +.Nm http +and +.Nm json +are replacements for .Xr curl 1 -that can be used for testing -.Nm . +and +.Xr jq 1 +that build on the +.Xr HttpClient 3 +and +.Xr Json +APIs. They exist mainly to test those APIs, but also to reduce +the number of dependencies that +.Nm +has. +.Nm http-debug-server +exists to test the +.Xr HttpServer 3 +and +.Xr HttpClient +APIs. +.It +Replaced all usage of +.Xr jq 1 +with the new +.Xr json 1 +tool. +.Xr jq 1 +is no longer a development dependency. +.It +Added a new +.Xr tt 1 +script for easily making Matrix requests against +.Nm +in development. +.El +.Pp +Fixes and general improvements: +.Bl -bullet +.It +Fixed a few warnings that were generated on some obscure compilers. +.It +Moved the +.Fn main +function into its own file to make it easier to link other programs +with the +.Nm +APIs. +.It +Fixed the development tools environment setup script. Apparently +using a hyphen as a bullet point is not very portable, because some +shell implementations of +.Xr printf 1 +interpret it as a flag. Switched to an asterisk instead. +.It +Fixed some intermittent I/O errors that would occur as a result of +race conditions in +.Fn JsonConsumeWhitespace . +This function, and a few others, expect I/O to be blocking, but +the +.Xr HttpServer 3 +sets up I/O to be non-blocking, leading to occasional failures in +JSON parsing. .El .Sh v0.2.1 .Pp @@ -141,7 +232,7 @@ Misc: .Bl -bullet .It Fixed a bug in -.Xr td 8 +.Xr td 1 that caused .Xr cvs 1 to be invoked in the wrong directory when tagging a new release. diff --git a/man/man7/telodendria-contributing.7 b/man/man7/telodendria-contributing.7 index 816e073..1aceb96 100644 --- a/man/man7/telodendria-contributing.7 +++ b/man/man7/telodendria-contributing.7 @@ -1,4 +1,4 @@ -.Dd $Mdocdate: January 6 2023 $ +.Dd $Mdocdate: March 10 2023 $ .Dt TELODENDRIA-CONTRIBUTING 7 .Os Telodendria Project .Sh NAME @@ -93,7 +93,7 @@ fact, I find it easier than having to make a GitHub account, forking a project's repository, and then making a pull request for it. Once you have made your changes in your local copy of the code, and you've configured your environment properly as noted in the manual for -.Xr td 8 , +.Xr td 1 , just run the patch recipe: .Bd -literal -offset indent $ td patch @@ -119,10 +119,10 @@ Subject: Document Patch Procedure .sp As much information should be filled out for you, such as the date. An attempt to fill out the From header was also made by -.Xr td 8 , +.Xr td 1 , but the information there can be modifed as necessary. Consult the manual for -.Xr td 8 +.Xr td 1 for more details. The Subject should very briefly describe what the patch is about. .sp diff --git a/man/man7/telodendria.7 b/man/man7/telodendria.7 index d5875af..9dee9dc 100644 --- a/man/man7/telodendria.7 +++ b/man/man7/telodendria.7 @@ -1,4 +1,4 @@ -.Dd $Mdocdate: February 15 2023 $ +.Dd $Mdocdate: March 10 2023 $ .Dt TELODENDRIA 7 .Os Telodendria Project .Sh NAME @@ -165,7 +165,7 @@ be afraid to call me out! .Sh SEE ALSO .Xr telodendria 8 , .Xr telodendria.conf 5 , -.Xr td 8 +.Xr td 1 .Sh STANDARDS The installed version of .Nm