threads / patch / 59345

patch, 2 partsdoc: rev-list: simple cleanups

Subject: [PATCH 0/2] doc: rev-list: simple cleanups

## tl;dr

3 messages between Mar 5, 2023 and Mar 5, 2023. Diffs are folded; open one to read it.

replies: 2people: 1as markdown or json

Felipe Contreras· Mar 5, 2023, 01:37 UTC · lore

Here are some simple cleanups to the asciidoc format of Documentation/rev-list-options.txt prompted by [1].

[1] https://lore.kernel.org/git/CAMP44s3Kqyrdavp1OiozNbA7k4EHCj0KiQq4d2Dyg_KZSEAUuQ@mail.gmail.com/

Felipe Contreras (2):
  doc: rev-list: simplify escaping
  doc: rev-list: simplify literals

 Documentation/rev-list-options.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

-- 
2.39.2

Felipe Contreras· Mar 5, 2023, 01:37 UTC · re: Felipe Contreras · lore

[PATCH 1/2] doc: rev-list: simplify escaping

<= is substituted with the unicode ⇐, but it's not necessary to use an HTML escape to prevent that, we can just use a blackslash.

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/rev-list-options.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to Documentation/rev-list-options.txt +1 −1

diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index 0d90d5b154..84c742aaac 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -970,7 +970,7 @@ the '--filter' flag and is usually not necessary. Filters are joined by
 '{plus}' and individual filters are %-encoded (i.e. URL-encoded).
 Besides the '{plus}' and '%' characters, the following characters are
 reserved and also must be encoded: `~!@#$^&*()[]{}\;",<>?`+&#39;&#96;+
-as well as all characters with ASCII code &lt;= `0x20`, which includes
+as well as all characters with ASCII code \<= `0x20`, which includes
 space and newline.
 +
 Other arbitrary characters can also be encoded. For instance,

-- 
2.39.2

Felipe Contreras· Mar 5, 2023, 01:37 UTC · re: Felipe Contreras · lore

[PATCH 2/2] doc: rev-list: simplify literals

We don't need to put special HTML escapes for ' and `.

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/rev-list-options.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to Documentation/rev-list-options.txt +1 −1

diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index 84c742aaac..df08a9e393 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -969,7 +969,7 @@ used to combined several filters, but this is harder than just repeating
 the '--filter' flag and is usually not necessary. Filters are joined by
 '{plus}' and individual filters are %-encoded (i.e. URL-encoded).
 Besides the '{plus}' and '%' characters, the following characters are
-reserved and also must be encoded: `~!@#$^&*()[]{}\;",<>?`+&#39;&#96;+
+reserved and also must be encoded: `~!@#$^&*()[]{}\;",<>?'``
 as well as all characters with ASCII code \<= `0x20`, which includes
 space and newline.
 +

-- 
2.39.2