Git Mailing List Archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/2] doc: manpage: get rid of an ancient asciidoc workaround
@ 2023-05-04  3:55 Felipe Contreras
  2023-05-04  3:55 ` [PATCH 1/2] doc: git-svn: use listing instead of verse Felipe Contreras
  2023-05-04  3:55 ` [PATCH 2/2] doc: manpage: remove ancient workaround Felipe Contreras
  0 siblings, 2 replies; 3+ messages in thread
From: Felipe Contreras @ 2023-05-04  3:55 UTC (permalink / raw)
  To: git; +Cc: Jeff King, Felipe Contreras

There a small issue removing the workaround in git-svn.txt, so that's
fixed first, which also improves the output with asciidoctor, and then
removing the workaround is a no-op.

Felipe Contreras (2):
  doc: git-svn: use listing instead of verse
  doc: manpage: remove ancient workaround

 Documentation/asciidoc.conf | 21 ------------------
 Documentation/git-svn.txt   | 43 +++++++++++++------------------------
 2 files changed, 15 insertions(+), 49 deletions(-)

-- 
2.40.0+fc1


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [PATCH 1/2] doc: git-svn: use listing instead of verse
  2023-05-04  3:55 [PATCH 0/2] doc: manpage: get rid of an ancient asciidoc workaround Felipe Contreras
@ 2023-05-04  3:55 ` Felipe Contreras
  2023-05-04  3:55 ` [PATCH 2/2] doc: manpage: remove ancient workaround Felipe Contreras
  1 sibling, 0 replies; 3+ messages in thread
From: Felipe Contreras @ 2023-05-04  3:55 UTC (permalink / raw)
  To: git; +Cc: Jeff King, Felipe Contreras

Code snippets are supposed to be listing blocks, not verse blocks, and
it's easy to add them by a simple indentation.

This fixes the output for asciidoctor in a few places and gets rid of
the need of  a hack for asciidoc introduced in 9b6f84d2c2 (asciidoc: add
minor workaround to add an empty line after code blocks, 2008-10-30),
plus shows the snippets in monospace font in the html backend.

  --- a/git-svn.1
  +++ b/git-svn.1
  @@ -148,6 +148,7 @@ COMMANDS
                  be used to allow only certain refs.

                      config key: svn-remote.<name>.ignore-refs
  +
                  If the ignore-refs configuration key is set, and the
                  command-line option is also given, both regular expressions
                  will be used.
  @@ -160,6 +161,7 @@ COMMANDS
                  etc) on a given repository.

                      config key: svn-remote.<name>.ignore-paths
  +
                  If the ignore-paths configuration key is set, and the
                  command-line option is also given, both regular expressions
                  will be used.
  @@ -260,6 +262,7 @@ COMMANDS

                      config key: svn-remote.<name>.commiturl
                      config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options)
  +
                  Note that the SVN URL of the commiturl config key includes the
                  SVN branch. If you rather want to set the commit URL for an
                  entire SVN repository use svn-remote.<name>.pushurl instead.
  @@ -277,6 +280,7 @@ COMMANDS
                  /branches/bar:3,5-6,8")

                      config key: svn.pushmergeinfo
  +
                  This option will cause git-svn to attempt to automatically
                  populate the svn:mergeinfo property in the SVN repository when
                  possible. Currently, this can only be done when dcommitting

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/git-svn.txt | 43 ++++++++++++++-------------------------
 1 file changed, 15 insertions(+), 28 deletions(-)

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 4e92308e85..79f767478f 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -148,8 +148,7 @@ the same local time zone.
 	`^refs/remotes/origin/(?!tags/wanted-tag|wanted-branch).*$`
 	can be used to allow only certain refs.
 +
-[verse]
-config key: svn-remote.<name>.ignore-refs
+ config key: svn-remote.<name>.ignore-refs
 +
 If the ignore-refs configuration key is set, and the command-line
 option is also given, both regular expressions will be used.
@@ -161,8 +160,7 @@ option is also given, both regular expressions will be used.
 	(including automatic fetches due to 'clone', 'dcommit',
 	'rebase', etc) on a given repository.
 +
-[verse]
-config key: svn-remote.<name>.ignore-paths
+ config key: svn-remote.<name>.ignore-paths
 +
 If the ignore-paths configuration key is set, and the command-line
 option is also given, both regular expressions will be used.
@@ -191,8 +189,7 @@ Skip "branches" and "tags" of first level directories;;
 	'rebase', etc) on a given repository. `--ignore-paths` takes
 	precedence over `--include-paths`.
 +
-[verse]
-config key: svn-remote.<name>.include-paths
+ config key: svn-remote.<name>.include-paths
 
 --log-window-size=<n>;;
 	Fetch <n> log entries per request when scanning Subversion history.
@@ -267,9 +264,8 @@ Use of 'dcommit' is preferred to 'set-tree' (below).
 	reused if a user is later given access to an alternate transport
 	method (e.g. `svn+ssh://` or `https://`) for commit.
 +
-[verse]
-config key: svn-remote.<name>.commiturl
-config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options)
+ config key: svn-remote.<name>.commiturl
+ config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options)
 +
 Note that the SVN URL of the commiturl config key includes the SVN branch.
 If you rather want to set the commit URL for an entire SVN repository use
@@ -286,8 +282,7 @@ discouraged.
 	branches, use a single space character between the branches
 	(`--mergeinfo="/branches/foo:1-10 /branches/bar:3,5-6,8"`)
 +
-[verse]
-config key: svn.pushmergeinfo
+ config key: svn.pushmergeinfo
 +
 This option will cause git-svn to attempt to automatically populate the
 svn:mergeinfo property in the SVN repository when possible. Currently, this can
@@ -608,8 +603,7 @@ removed by default if there are no files left in them.  Git
 cannot version empty directories.  Enabling this flag will make
 the commit to SVN act like Git.
 +
-[verse]
-config key: svn.rmdir
+ config key: svn.rmdir
 
 -e::
 --edit::
@@ -619,8 +613,7 @@ Edit the commit message before committing to SVN.  This is off by
 default for objects that are commits, and forced on when committing
 tree objects.
 +
-[verse]
-config key: svn.edit
+ config key: svn.edit
 
 -l<num>::
 --find-copies-harder::
@@ -629,9 +622,8 @@ config key: svn.edit
 They are both passed directly to 'git diff-tree'; see
 linkgit:git-diff-tree[1] for more information.
 +
-[verse]
-config key: svn.l
-config key: svn.findcopiesharder
+ config key: svn.l
+ config key: svn.findcopiesharder
 
 -A<filename>::
 --authors-file=<filename>::
@@ -648,8 +640,7 @@ will abort operation. The user will then have to add the
 appropriate entry.  Re-running the previous 'git svn' command
 after the authors-file is modified should continue operation.
 +
-[verse]
-config key: svn.authorsfile
+ config key: svn.authorsfile
 
 --authors-prog=<filename>::
 	If this option is specified, for each SVN committer name that
@@ -664,8 +655,7 @@ relative to the current directory for 'init' and 'clone' and relative
 to the root of the working tree for 'fetch'. If 'filename' is
 not found, it is searched like any other command in '$PATH'.
 +
-[verse]
-config key: svn.authorsProg
+ config key: svn.authorsProg
 
 -q::
 --quiet::
@@ -703,8 +693,7 @@ creating the branch or tag.
 	'dcommit' operations), look for the first `From:` line or `Signed-off-by` trailer
 	in the log message and use that as the author string.
 +
-[verse]
-config key: svn.useLogAuthor
+ config key: svn.useLogAuthor
 
 --add-author-from::
 	When committing to svn from Git (as part of 'set-tree' or 'dcommit'
@@ -713,8 +702,7 @@ config key: svn.useLogAuthor
 	Git commit's author string.  If you use this, then `--use-log-author`
 	will retrieve a valid author string for all commits.
 +
-[verse]
-config key: svn.addAuthorFrom
+ config key: svn.addAuthorFrom
 
 ADVANCED OPTIONS
 ----------------
@@ -748,8 +736,7 @@ ADVANCED OPTIONS
 	process. This feature is enabled by default, use
 	--no-follow-parent to disable it.
 +
-[verse]
-config key: svn.followparent
+ config key: svn.followparent
 
 CONFIG FILE-ONLY OPTIONS
 ------------------------
-- 
2.40.0+fc1


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* [PATCH 2/2] doc: manpage: remove ancient workaround
  2023-05-04  3:55 [PATCH 0/2] doc: manpage: get rid of an ancient asciidoc workaround Felipe Contreras
  2023-05-04  3:55 ` [PATCH 1/2] doc: git-svn: use listing instead of verse Felipe Contreras
@ 2023-05-04  3:55 ` Felipe Contreras
  1 sibling, 0 replies; 3+ messages in thread
From: Felipe Contreras @ 2023-05-04  3:55 UTC (permalink / raw)
  To: git; +Cc: Jeff King, Felipe Contreras

This was added in 9b6f84d2c2 (asciidoc: add minor workaround to add an
empty line after code blocks, 2008-10-30) in order to deal with a bug in
docbook-xsl 1.72, but it was fixed in 1.74 in 2008.

No functional changes.

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/asciidoc.conf | 21 ---------------------
 1 file changed, 21 deletions(-)

diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf
index 60f76f43ed..7e3de98cd7 100644
--- a/Documentation/asciidoc.conf
+++ b/Documentation/asciidoc.conf
@@ -30,27 +30,6 @@ ifdef::backend-docbook[]
 {0#</citerefentry>}
 endif::backend-docbook[]
 
-ifdef::backend-docbook[]
-ifdef::doctype-manpage[]
-# The following two small workarounds insert a simple paragraph after screen
-[listingblock]
-<example><title>{title}</title>
-<literallayout class="monospaced">
-|
-</literallayout><simpara></simpara>
-{title#}</example>
-
-[verseblock]
-<formalpara{id? id="{id}"}><title>{title}</title><para>
-{title%}<literallayout{id? id="{id}"}>
-{title#}<literallayout>
-|
-</literallayout>
-{title#}</para></formalpara>
-{title%}<simpara></simpara>
-endif::doctype-manpage[]
-endif::backend-docbook[]
-
 ifdef::backend-xhtml11[]
 [attributes]
 git-relative-html-prefix=
-- 
2.40.0+fc1


^ permalink raw reply related	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2023-05-04  3:55 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-05-04  3:55 [PATCH 0/2] doc: manpage: get rid of an ancient asciidoc workaround Felipe Contreras
2023-05-04  3:55 ` [PATCH 1/2] doc: git-svn: use listing instead of verse Felipe Contreras
2023-05-04  3:55 ` [PATCH 2/2] doc: manpage: remove ancient workaround Felipe Contreras

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).