user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
From: Kyle Meyer <kyle@kyleam.com>
To: meta@public-inbox.org
Cc: Kyle Meyer <kyle@kyleam.com>
Subject: [PATCH] doc: escape internal ">" in listid code snippet
Date: Sat, 11 Apr 2020 17:05:01 -0400	[thread overview]
Message-ID: <20200411210501.12997-1-kyle@kyleam.com> (raw)

A code snippet in the listid description is incorrectly rendered as

    "publicinbox.$NAME.watchheader=List-Id:<foo.example.com">

Escape the closing bracket around the List-Id value to avoid this.
Also escape the opening bracket for symmetry/readability.
---
 Documentation/public-inbox-config.pod | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index 53926ef4..4c9994dc 100644
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -99,7 +99,7 @@ angle brackets for L<public-inbox-mda(1)> deliveries and
 L<public-inbox-watch(1)>.
 
 For public-inbox-watch users, this is a shortcut for specifying
-C<publicinbox.$NAME.watchheader=List-Id:<foo.example.com>>
+C<publicinbox.$NAME.watchheader=List-Id:E<lt>foo.example.comE<gt>>
 
 For public-inbox-mda users, this may be used to avoid recipient
 matching via C<ORIGINAL_RECIPIENT> environment variable.

base-commit: d7270ec79e6347eb1c35ebcdc197e887bb4ef075
-- 
2.26.0


             reply	other threads:[~2020-04-11 21:05 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-11 21:05 Kyle Meyer [this message]
2020-04-12 21:42 ` [PATCH] doc: escape internal ">" in listid code snippet Eric Wong

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: http://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=20200411210501.12997-1-kyle@kyleam.com \
    --to=kyle@kyleam.com \
    --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).