[PATCH gcli] Amend manpages for compatibility with groff
Export this patch
From: remph <lhr@disroot.org>
Escapes spaces in .Nm so eg. `gcli pulls' is one discrete unit. groff_mdoc(7)
doesn't like multiple arguments to .Nm; previously subsequent references
to .Nm (without arguments) would just show `gcli' rather than eg. `gcli pulls'.
Thanks! What a silly mistake. I never noticed this bug since
groff_mdoc isn't the default preprocessor on FreeBSD (which is using
mandoc from OpenBSD). However when manually preprocessing the page
with groff_mdoc the issue becomes very visible :D
I applied the patch and pushed it.
Nico
Also update docs/.gitignore
---
docs/.gitignore | 1 +
docs/gcli-api.1.in | 2 + -
docs/gcli-comment.1.in | 2 + -
docs/gcli-config.1.in | 2 + -
docs/gcli-forks.1.in | 2 + -
docs/gcli-gists.1.in | 2 + -
docs/gcli-issues.1.in | 2 + -
docs/gcli-labels.1.in | 2 + -
docs/gcli-milestones.1.in | 2 + -
docs/gcli-pipelines.1.in | 2 + -
docs/gcli-pulls-review.1.in | 2 + -
docs/gcli-pulls.1.in | 2 + -
docs/gcli-releases.1.in | 2 + -
docs/gcli-repos.1.in | 2 + -
docs/gcli-snippets.1.in | 2 + -
docs/gcli-status.1.in | 2 + -
16 files changed, 16 insertions(+), 15 deletions(-)
diff --git a/docs/.gitignore b/docs/.gitignore
index 01bb910c..4e1d9858 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -8,6 +8,7 @@
/gcli-milestones.1
/gcli-pipelines.1
/gcli-pulls.1
+ /gcli-pulls-review.1
/gcli-releases.1
/gcli-repos.1
/gcli-snippets.1
diff --git a/docs/gcli-api.1.in b/docs/gcli-api.1.in
index 53e392db..f15eabbf 100644
--- a/docs/gcli-api.1.in
+++ b/docs/gcli-api.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-API 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli api
+ .Nm gcli\ api
.Nd Perform API Calls to Git Forges and retrieve results
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-comment.1.in b/docs/gcli-comment.1.in
index a670a59f..defee83f 100644
--- a/docs/gcli-comment.1.in
@@ -3,7 +3,7 @@
.Os @PACKAGE_STRING@
.Dd $Mdocdate$
.Sh NAME
- .Nm gcli comment
+ .Nm gcli\ comment
.Nd Comment on tickets in git forges
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-config.1.in b/docs/gcli-config.1.in
index 3c11ef76..667d4b30 100644
--- a/docs/gcli-config.1.in
+++ b/docs/gcli-config.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-ISSUES 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli config
+ .Nm gcli\ config
.Nd Git Forge Configuration
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-forks.1.in b/docs/gcli-forks.1.in
index 3b2a3c59..4bcceec0 100644
--- a/docs/gcli-forks.1.in
+++ b/docs/gcli-forks.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-FORKS 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli forks
+ .Nm gcli\ forks
.Nd Manage repository forks in git forges
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-gists.1.in b/docs/gcli-gists.1.in
index 088efb4c..683b9fe6 100644
--- a/docs/gcli-gists.1.in
+++ b/docs/gcli-gists.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-GISTS 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli gists
+ .Nm gcli\ gists
.Nd manage GitHub Gists
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-issues.1.in b/docs/gcli-issues.1.in
index c9e18354..37efd1cd 100644
--- a/docs/gcli-issues.1.in
+++ b/docs/gcli-issues.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-ISSUES 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli issues
+ .Nm gcli\ issues
.Nd Manage issues in various git forges
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-labels.1.in b/docs/gcli-labels.1.in
index 9706cb95..d4051da2 100644
--- a/docs/gcli-labels.1.in
+++ b/docs/gcli-labels.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-LABELS 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli labels
+ .Nm gcli\ labels
.Nd Manage ticket labels in git forges
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-milestones.1.in b/docs/gcli-milestones.1.in
index d169aa19..3596b1d3 100644
--- a/docs/gcli-milestones.1.in
+++ b/docs/gcli-milestones.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-MILESTONES 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli milestones
+ .Nm gcli\ milestones
.Nd List and manage milestones in various Git Forges
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-pipelines.1.in b/docs/gcli-pipelines.1.in
index f09a839b..7a5c75a9 100644
--- a/docs/gcli-pipelines.1.in
+++ b/docs/gcli-pipelines.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-PIPELINES 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli pipelines
+ .Nm gcli\ pipelines
.Nd Inspect and manage GitLab Pipelines
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-pulls-review.1.in b/docs/gcli-pulls-review.1.in
index a622ef44..7c928d6d 100644
--- a/docs/gcli-pulls-review.1.in
+++ b/docs/gcli-pulls-review.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-PULLS-REVIEW 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli pulls review
+ .Nm gcli\ pulls\ review
.Nd GCLI Integrated Code Review Tool
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-pulls.1.in b/docs/gcli-pulls.1.in
index 06d7cfe8..00ccc563 100644
--- a/docs/gcli-pulls.1.in
+++ b/docs/gcli-pulls.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-PULLS 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli pulls
+ .Nm gcli\ pulls
.Nd Manage Pull Requests on Git Forges
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-releases.1.in b/docs/gcli-releases.1.in
index 97a4617a..eece1cf4 100644
--- a/docs/gcli-releases.1.in
+++ b/docs/gcli-releases.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-RELEASES 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli releases
+ .Nm gcli\ releases
.Nd manage releases on git forges
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-repos.1.in b/docs/gcli-repos.1.in
index 2c6551fe..c29aa147 100644
--- a/docs/gcli-repos.1.in
+++ b/docs/gcli-repos.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-REPOS 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli repos
+ .Nm gcli\ repos
.Nd Manage remote repositories on various git forges
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-snippets.1.in b/docs/gcli-snippets.1.in
index af6ea03a..fcc629a0 100644
--- a/docs/gcli-snippets.1.in
+++ b/docs/gcli-snippets.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-SNIPPETS 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli snippets
+ .Nm gcli\ snippets
.Nd manage GitLab snippets
.Sh SYNOPSIS
.Nm
diff --git a/docs/gcli-status.1.in b/docs/gcli-status.1.in
index 2ced9c66..826fa781 100644
--- a/docs/gcli-status.1.in
+++ b/docs/gcli-status.1.in
@@ -2,7 +2,7 @@
.Dt GCLI-STATUS 1
.Os @PACKAGE_STRING@
.Sh NAME
- .Nm gcli status
+ .Nm gcli\ status
.Nd Print a list of notifications and/or TODOs
.Sh SYNOPSIS
.Nm
--
2.47.1
lhr@disroot.org wrote: