git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Martin Ågren" <martin.agren@gmail.com>
To: git@vger.kernel.org
Subject: [PATCH 5/6] git-svn.txt: change verse to listing block
Date: Thu, 13 May 2021 20:17:44 +0200	[thread overview]
Message-ID: <96c5a7ce800b37306274a6725ad44582fefb06a8.1620928059.git.martin.agren@gmail.com> (raw)
In-Reply-To: <cover.1620928059.git.martin.agren@gmail.com>

Unlike AsciiDoc, Asciidoctor seems to leave out an empty line after a verse
in a list continuation:

  allow only certain refs.

       config key: svn-remote.<name>.ignore-refs
  If the ignore-refs configuration key is ...

We could probably convince Asciidoctor do this differently, but thinking
about it, there's no real reason for a "verse" here. We might as well
use a listing block.

This is the only place in our documentation that uses this "config key:
foo.bar" construction. We could rework it into prose ("This option
overrides the foo.bar configuration, which defaults to baz."). Right
now, let's just solve the immediate issue of the missing empty line when
we use Asciidoctor to generate the manpage.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 Documentation/git-svn.txt | 45 ++++++++++++++++++++++++++-------------
 1 file changed, 30 insertions(+), 15 deletions(-)

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index d5776ffcfd..4e62dc37e7 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -148,8 +148,9 @@ 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
+------------
 +
 If the ignore-refs configuration key is set, and the command-line
 option is also given, both regular expressions will be used.
@@ -161,8 +162,9 @@ 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
+------------
 +
 If the ignore-paths configuration key is set, and the command-line
 option is also given, both regular expressions will be used.
@@ -191,8 +193,9 @@ 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
+------------
 
 --log-window-size=<n>;;
 	Fetch <n> log entries per request when scanning Subversion history.
@@ -267,9 +270,10 @@ 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)
+------------
 +
 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 +290,9 @@ 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
+------------
 +
 This option will cause git-svn to attempt to automatically populate the
 svn:mergeinfo property in the SVN repository when possible. Currently, this can
@@ -548,9 +553,10 @@ Assume you have local changes in "master", but you need to refetch "r2".
 Fix the ignore-paths or SVN permissions problem that caused "r2" to
 be incomplete in the first place.  Then:
 +
-[verse]
+------------
 git svn reset -r2 -p
 git svn fetch
+------------
 +
 ------------
     r1---r2'--r3' remotes/git-svn
@@ -562,8 +568,9 @@ Then fixup "master" with 'git rebase'.
 Do NOT use 'git merge' or your history will not be compatible with a
 future 'dcommit'!
 +
-[verse]
+------------
 git rebase --onto remotes/git-svn A^ master
+------------
 +
 ------------
     r1---r2'--r3' remotes/git-svn
@@ -608,8 +615,9 @@ 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
+------------
 
 -e::
 --edit::
@@ -619,8 +627,9 @@ 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
+------------
 
 -l<num>::
 --find-copies-harder::
@@ -629,9 +638,10 @@ 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
+------------
 
 -A<filename>::
 --authors-file=<filename>::
@@ -648,8 +658,9 @@ 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
+------------
 
 --authors-prog=<filename>::
 	If this option is specified, for each SVN committer name that
@@ -664,8 +675,9 @@ 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
+------------
 
 -q::
 --quiet::
@@ -704,8 +716,9 @@ 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
+------------
 
 --add-author-from::
 	When committing to svn from Git (as part of 'set-tree' or 'dcommit'
@@ -714,8 +727,9 @@ 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
+------------
 
 ADVANCED OPTIONS
 ----------------
@@ -749,8 +763,9 @@ ADVANCED OPTIONS
 	process. This feature is enabled by default, use
 	--no-follow-parent to disable it.
 +
-[verse]
+------------
 config key: svn.followparent
+------------
 
 CONFIG FILE-ONLY OPTIONS
 ------------------------
-- 
2.31.1.751.gd2f1c929bd


  parent reply	other threads:[~2021-05-13 18:18 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-13 18:17 [PATCH 0/6] AsciiDoc vs Asciidoctor, once again Martin Ågren
2021-05-13 18:17 ` [PATCH 1/6] git-http-push.txt,git-send-pack.txt: avoid single quote Martin Ågren
2021-05-13 18:17 ` [PATCH 2/6] git-range-diff.txt: avoid single quotes Martin Ågren
2021-05-13 18:17 ` [PATCH 3/6] git-check-ref-format.txt: avoid single quote Martin Ågren
2021-05-13 19:16   ` Eric Sunshine
2021-05-13 19:35     ` Martin Ågren
2021-05-13 22:00   ` Junio C Hamano
2021-05-14  9:07     ` Martin Ågren
2021-05-14 12:30       ` Felipe Contreras
2021-05-14  5:30   ` Jeff King
2021-05-14  9:08     ` Martin Ågren
2021-05-13 18:17 ` [PATCH 4/6] diff-options.txt: move monospace markup out of attribute Martin Ågren
2021-05-13 18:17 ` Martin Ågren [this message]
2021-05-13 18:17 ` [PATCH 6/6] Doc: use two backticks for monospace, not backtick+apostrophe Martin Ågren
2021-05-13 20:35 ` [PATCH 0/6] AsciiDoc vs Asciidoctor, once again Junio C Hamano
2021-05-14  8:40   ` Martin Ågren
2021-05-14 12:18     ` Felipe Contreras
2021-05-14  1:40 ` Felipe Contreras
2021-05-14  8:43   ` Martin Ågren
2021-05-14 12:24     ` Felipe Contreras
2021-05-14 15:28       ` Martin Ågren
2021-05-14 20:11         ` Felipe Contreras

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://vger.kernel.org/majordomo-info.html

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

  git send-email \
    --in-reply-to=96c5a7ce800b37306274a6725ad44582fefb06a8.1620928059.git.martin.agren@gmail.com \
    --to=martin.agren@gmail.com \
    --cc=git@vger.kernel.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/mirrors/git.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).