~zethra/public-inbox

This thread contains a patchset. You're looking at the original emails, but you may wish to use the patch review UI. Review patch
1

[PATCH stargazer] Change ip-log to log-ip in docs and fix spelling

Details
Message ID
<20240803173053.432391-1-bj@benjaminja.com>
DKIM signature
pass
Download raw message
Patch: +31 -31
---
 README.md               |  6 +++---
 doc/stargazer-ini.scd   | 20 ++++++++++----------
 doc/stargazer.1.txt     |  6 +++---
 doc/stargazer.ini.5.txt | 24 ++++++++++++------------
 doc/stargazer.scd       |  6 +++---
 5 files changed, 31 insertions(+), 31 deletions(-)

diff --git a/README.md b/README.md
index da8b151..03d89c5 100644
--- a/README.md
+++ b/README.md
@@ -124,9 +124,9 @@ under the terms of the [GNU AFFERO GENERAL PUBLIC LICENSE Version 3](./LICENSE).

## Contributing

Please send any and all patches, bugs, and questions to the stargazer mailing
list [~zethra/stargazer@lists.sr.ht](mailto:~zethra/stargazer@lists.sr.ht)
or submit a ticket to the bug tracker if you feel so inclined
Please send any and all patches, bugs, and questions to my mailing list
[~zethra/public-inbox@lists.sr.ht](mailto:~zethra/public-inbox@lists.sr.ht) with
the prefix stargazer or submit a ticket to the bug tracker if you feel so inclined
[todo.sr.ht/~zethra/stargazer](https://todo.sr.ht/~zethra/stargazer).
You can also contact me directly. Up-to-date contact info can be found on my
website [sashanoraa.gay](https://sashanoraa.gay/).
diff --git a/doc/stargazer-ini.scd b/doc/stargazer-ini.scd
index f08b003..2c23867 100644
--- a/doc/stargazer-ini.scd
+++ b/doc/stargazer-ini.scd
@@ -57,16 +57,16 @@ that *stargazer* will server requests to. At least one route must be specified.
	Whether or not to log connections to stdout. Disabling this may increase
	performance. On by default. Always on if the debug cli flag is on.

*ip-log*
*log-ip*
	Log client IP addresses in the connection log. Mutually exclusive with
	*ip-log-partial*. Off by default.
	*log-ip-partial*. Off by default.

*ip-log-partial*
*log-ip-partial*
	Log partial client IP addresses in the connection log. For IPv4 addresses
	only the first 2 octets are logged, the rest are zeroed. For IPv6 addresses
	only the first 3 16bit segments are logged, the rest are zeroed. May be
	preferable to *ip-log* to help maintain user privacy. Mutually exclusive
	with *ip-log-partial*. Off by default.
	preferable to *log-ip* to help maintain user privacy. Mutually exclusive
	with *log-ip-partial*. Off by default.

*request-timeout*
	Number of seconds to wait for the client to send a complete request.  If
@@ -188,14 +188,14 @@ Within each routing section, the following keys are used to configure how
*auto-index*
	"on" to enable the auto-index feature, which presents clients with a
	list of files in the requested directory when an index file cannot be
	found. Off by default. Only availible for static file routes.
	found. Off by default. Only available for static file routes.

*lang*
	Set this value as the *lang* parameter for gemini files served under this
	route. The lang param will only be set for text/gemini responses. The Gemini
	Specification says that the lang parameter should contain a comma separated
	list of language identifier from RFC 4646. Stargazer will use the lang
	parameter as given in this config. It is up to the user to provid a valid
	parameter as given in this config. It is up to the user to provide a valid
	list of languages. Currently, this parameter is only used when serving
	static files.

@@ -206,7 +206,7 @@ Within each routing section, the following keys are used to configure how
	text/gemini responses. The Gemini Specification says that the charset
	parameter should be a character set specified in RFC 2046. Stargazer will
	use the charset parameter as given in this config. It is up to the user to
	provid a valid charset value. Currently, this parameter is only used when
	provide a valid charset value. Currently, this parameter is only used when
	serving static files.

*mime-override*
@@ -372,7 +372,7 @@ New headers:
:  1
:  SCGI Version

\[1]: Aways *0* since gemini doesn't have request bodies but included as it's
\[1]: Always *0* since gemini doesn't have request bodies but included as it's
required by the SCGI protocol.

CGI header that are omitted from SCGI:
@@ -383,4 +383,4 @@ CGI header that are omitted from SCGI:

Maintained by Sashanoraa <sasha@noraa.gay>. Up-to-date sources can be found at
https://sr.ht/~zethra/stargazer/ and bugs/patches can be submitted by email to
~zethra/stargazer@lists.sr.ht.
~zethra/public-inbox@lists.sr.ht with the prefix stargazer.
diff --git a/doc/stargazer.1.txt b/doc/stargazer.1.txt
index 1100284..1f24b10 100644
--- a/doc/stargazer.1.txt
+++ b/doc/stargazer.1.txt
@@ -48,7 +48,7 @@ SEE ALSO
AUTHORS
       Maintained  by Sashanoraa <sasha@noraa.gay>. Up-to-date sources
       can   be   found   at   https://sr.ht/~zethra/stargazer/    and
       bugs/patches     can     be     submitted     by    email    to
       ~zethra/stargazer@lists.sr.ht.
       bugs/patches  can  be  submitted by email to ~zethra/public-in‐
       box@lists.sr.ht with the prefix stargazer.

                              2024-08-02                  stargazer(1)
                              2024-08-03                  stargazer(1)
diff --git a/doc/stargazer.ini.5.txt b/doc/stargazer.ini.5.txt
index c34d3e8..826bff3 100644
--- a/doc/stargazer.ini.5.txt
+++ b/doc/stargazer.ini.5.txt
@@ -57,17 +57,17 @@ CONFIGURATION KEYS
           may increase performance. On by default. Always on  if  the
           debug cli flag is on.

       ip-log
       log-ip
           Log client IP addresses in the connection log. Mutually ex‐
           clusive with ip-log-partial. Off by default.
           clusive with log-ip-partial. Off by default.

       ip-log-partial
       log-ip-partial
           Log partial client IP addresses in the connection log.  For
           IPv4 addresses only the first 2 octets are logged, the rest
           are zeroed. For IPv6 addresses only the first 3 16bit  seg‐
           ments are logged, the rest are zeroed. May be preferable to
           ip-log to help maintain user  privacy.  Mutually  exclusive
           with ip-log-partial. Off by default.
           log-ip to help maintain user  privacy.  Mutually  exclusive
           with log-ip-partial. Off by default.

       request-timeout
           Number of seconds to wait for the client to send a complete
@@ -191,7 +191,7 @@ CONFIGURATION KEYS
           "on" to  enable  the  auto-index  feature,  which  presents
           clients  with  a  list  of files in the requested directory
           when an index file cannot be found. Off  by  default.  Only
           availible for static file routes.
           available for static file routes.

       lang
           Set  this  value  as  the  lang  parameter for gemini files
@@ -200,7 +200,7 @@ CONFIGURATION KEYS
           that the lang parameter should contain  a  comma  separated
           list  of  language identifier from RFC 4646. Stargazer will
           use the lang parameter as given in this config. It is up to
           the  user  to  provid a valid list of languages. Currently,
           the  user  to provide a valid list of languages. Currently,
           this parameter is only used when serving static files.

       charset
@@ -211,7 +211,7 @@ CONFIGURATION KEYS
           responses. The Gemini Specification says that  the  charset
           parameter  should be a character set specified in RFC 2046.
           Stargazer will use the charset parameter as given  in  this
           config.  It  is  up  to  the user to provid a valid charset
           config.  It  is  up  to the user to provide a valid charset
           value. Currently, this parameter is only used when  serving
           static files.

@@ -397,7 +397,7 @@ SCGI Support
       ├───────────────┼─────────┼────────────────────────────────────┤
       │SCGI           │ 1       │ SCGI Version                       │
       └───────────────┴─────────┴────────────────────────────────────┘
       [1]:  Aways  0 since gemini doesn't have request bodies but in‐
       [1]:  Always 0 since gemini doesn't have request bodies but in‐
       cluded as it's required by the SCGI protocol.

       CGI header that are omitted from SCGI:
@@ -407,7 +407,7 @@ SCGI Support
AUTHORS
       Maintained by Sashanoraa <sasha@noraa.gay>. Up-to-date  sources
       can    be   found   at   https://sr.ht/~zethra/stargazer/   and
       bugs/patches    can    be     submitted     by     email     to
       ~zethra/stargazer@lists.sr.ht.
       bugs/patches can be submitted by  email  to  ~zethra/public-in‐
       box@lists.sr.ht with the prefix stargazer.

                              2024-08-02              stargazer.ini(5)
                              2024-08-03              stargazer.ini(5)
diff --git a/doc/stargazer.scd b/doc/stargazer.scd
index 12c6c6b..6f4fc14 100644
--- a/doc/stargazer.scd
+++ b/doc/stargazer.scd
@@ -50,6 +50,6 @@ following fields in order, separated by a tab character:

# AUTHORS

Maintained by Sashanoraa <sasha@noraa.gay>. Up-to-date sources can be
found at https://sr.ht/~zethra/stargazer/ and bugs/patches can be submitted by
email to ~zethra/stargazer@lists.sr.ht.
Maintained by Sashanoraa <sasha@noraa.gay>. Up-to-date sources can be found at
https://sr.ht/~zethra/stargazer/ and bugs/patches can be submitted by email to
~zethra/public-inbox@lists.sr.ht with the prefix stargazer.
-- 
2.30.2
Details
Message ID
<D36GNYVW4FI0.3QSU6KNZTYHYO@benjaminja.com>
In-Reply-To
<20240803173053.432391-1-bj@benjaminja.com> (view parent)
DKIM signature
pass
Download raw message
In this patch, I have made some minor changes to the docs:

* Replaced ip-log with log-ip in doc/stargazer-ini.scd 
* Fix spelling mistakes
* Update the mailing list address in both docs and README.md
Reply to thread Export thread (mbox)