user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 3/3] doc: fix formatting for CLI switch aliases
Date: Tue, 13 Feb 2024 09:31:29 +0000	[thread overview]
Message-ID: <20240213093129.2379230-4-e@80x24.org> (raw)
In-Reply-To: <20240213093129.2379230-1-e@80x24.org>

`=item' elements in Pod need to be surrounded by empty lines.
It's an unfortunate waste of vertical space, but Pod is still better
than *roff and usually available out-of-the-box.
---
 Documentation/lei-q.pod               | 2 ++
 Documentation/public-inbox-clone.pod  | 1 +
 Documentation/public-inbox-config.pod | 2 ++
 3 files changed, 5 insertions(+)

diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod
index 95f3f702..4476a806 100644
--- a/Documentation/lei-q.pod
+++ b/Documentation/lei-q.pod
@@ -130,9 +130,11 @@ Caveat: C<-tt> only works on locally-indexed messages at the
 moment, and not on remote (HTTP(S)) endpoints.
 
 =item --jobs=QUERY_WORKERS[,WRITE_WORKERS]
+
 =item --jobs=,WRITE_WORKERS
 
 =item -j QUERY_WORKERS[,WRITE_WORKERS]
+
 =item -j ,WRITE_WORKERS
 
 Set the number of query and write worker processes for parallelism.
diff --git a/Documentation/public-inbox-clone.pod b/Documentation/public-inbox-clone.pod
index c3254fa0..64ee3138 100644
--- a/Documentation/public-inbox-clone.pod
+++ b/Documentation/public-inbox-clone.pod
@@ -234,6 +234,7 @@ Whether to wrap L<git(1)> and L<curl(1)> commands with L<torsocks(1)>.
 Default: C<auto>
 
 =item -j JOBS
+
 =item --jobs=JOBS
 
 The number of parallel processes to spawn at once for various network
diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index b875df58..d3f5d04b 100644
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -356,7 +356,9 @@ is set and the C<cgit> binary exists).
 See L<public-inbox-edit(1)>
 
 =item publicinbox.indexMaxSize
+
 =item publicinbox.indexBatchSize
+
 =item publicinbox.indexSequentialShard
 
 See L<public-inbox-index(1)>

      parent reply	other threads:[~2024-02-13  9:31 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-13  9:31 [PATCH 0/3] www cgit support updates Eric Wong
2024-02-13  9:31 ` [PATCH 1/3] www: cgit: support non-standard cgitrc locations Eric Wong
2024-02-13  9:31 ` [PATCH 2/3] doc: config: cgit=rewrite isn't implemented, yet Eric Wong
2024-02-13  9:31 ` Eric Wong [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240213093129.2379230-4-e@80x24.org \
    --to=e@80x24.org \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/public-inbox.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).