threads / patch / 7041

patch, 4 partsDocumentation/build-docdep.perl: Fix dependencies for included asciidoc files

Subject: [PATCH 1/4] Documentation/build-docdep.perl: Fix dependencies for included asciidoc files

## tl;dr

6 messages between Mar 1, 2007 and Mar 2, 2007. Diffs are folded; open one to read it.

replies: 5people: 2as markdown or json

Sergey Vlasov· Mar 1, 2007, 19:41 UTC · lore

Adding dependencies on included files to the generated man pages is wrong - includes are processed by asciidoc, therefore the intermediate Docbook XML files really depend on included files. Because of these wrong dependencies the man pages were not rebuilt properly if the intermediate XML files were left in the tree.

Signed-off-by: Sergey Vlasov <vsu@altlinux.ru>
---
 Documentation/build-docdep.perl |    6 +-----
 1 files changed, 1 insertions(+), 5 deletions(-)
Show changes to Documentation/build-docdep.perl +1 −5
diff --git a/Documentation/build-docdep.perl b/Documentation/build-docdep.perl
index 489389c..ba4205e 100755
--- a/Documentation/build-docdep.perl
+++ b/Documentation/build-docdep.perl
@@ -41,10 +41,6 @@ while ($changed) {
 while (my ($text, $included) = each %include) {
     if (! exists $included{$text} &&
 	(my $base = $text) =~ s/\.txt$//) {
-	my ($suffix) = '1';
-	if ($base eq 'git') {
-	    $suffix = '7'; # yuck...
-	}
-	print "$base.html $base.$suffix : ", join(" ", keys %$included), "\n";
+	print "$base.html $base.xml : ", join(" ", keys %$included), "\n";
     }
 }
-- 
1.5.0.2.285.g5347
Sergey Vlasov· Mar 1, 2007, 19:41 UTC · re: Sergey Vlasov · lore

[PATCH 2/4] Documentation/git-quiltimport.txt: Fix labeled list formatting

Mark the continuation paragraph of a list entry as such to avoid getting a literal paragraph instead.

Signed-off-by: Sergey Vlasov <vsu@altlinux.ru>
---
 Documentation/git-quiltimport.txt |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)
Show changes to Documentation/git-quiltimport.txt +4 −4
diff --git a/Documentation/git-quiltimport.txt b/Documentation/git-quiltimport.txt
index 6e9a8c3..296937a 100644
--- a/Documentation/git-quiltimport.txt
+++ b/Documentation/git-quiltimport.txt
@@ -42,10 +42,10 @@ OPTIONS
 --patches <dir>::
 	The directory to find the quilt patches and the
 	quilt series file.
-
-        The default for the patch directory is patches
-	or the value of the $QUILT_PATCHES environment
-	variable.
++
+The default for the patch directory is patches
+or the value of the $QUILT_PATCHES environment
+variable.
 
 Author
 ------
-- 
1.5.0.2.285.g5347
Sergey Vlasov· Mar 1, 2007, 19:41 UTC · re: Sergey Vlasov · lore

[PATCH 3/4] Documentation/git-send-email.txt: Fix labeled list formatting

Mark continuation paragraphs of list entries as such to avoid getting literal paragraphs instead.

Signed-off-by: Sergey Vlasov <vsu@altlinux.ru>
---
 Documentation/git-send-email.txt |   12 ++++++------
 1 files changed, 6 insertions(+), 6 deletions(-)
Show changes to Documentation/git-send-email.txt +6 −6
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 4c8d907..35b0104 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -26,13 +26,13 @@ The options available are:
 
 --bcc::
 	Specify a "Bcc:" value for each email.
-
-	The --bcc option must be repeated for each user you want on the bcc list.
++
+The --bcc option must be repeated for each user you want on the bcc list.
 
 --cc::
 	Specify a starting "Cc:" value for each email.
-
-	The --cc option must be repeated for each user you want on the cc list.
++
+The --cc option must be repeated for each user you want on the cc list.
 
 --chain-reply-to, --no-chain-reply-to::
 	If this is set, each email will be sent as a reply to the previous
@@ -87,8 +87,8 @@ The options available are:
 	Specify the primary recipient of the emails generated.
 	Generally, this will be the upstream maintainer of the
 	project involved.
-
-	The --to option must be repeated for each user you want on the to list.
++
+The --to option must be repeated for each user you want on the to list.
 
 
 Author
-- 
1.5.0.2.285.g5347
Sergey Vlasov· Mar 1, 2007, 19:41 UTC · re: Sergey Vlasov · lore

[PATCH 4/4] Documentation/git-svn.txt: Fix formatting errors

Fix some formatting problems:
  - Some list labels were missing their "::" characters.
  - Some of continuation paragraphs in labeled lists were incorrectly
    formatted as literal paragraphs.
  - In one case "[verse]" was missing before the config key list.
  - The "Basic Examples" section was incorrectly nested inside the
    "Config File-Only Options" section.
Signed-off-by: Sergey Vlasov <vsu@altlinux.ru>
Cc: Eric Wong <normalperson@yhbt.net>
---
 Documentation/git-svn.txt |  119 +++++++++++++++++++++++++--------------------
 1 files changed, 67 insertions(+), 52 deletions(-)
Show changes to Documentation/git-svn.txt +67 −50
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index cf094ca..06b49b0 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -63,7 +63,7 @@ COMMANDS
 	transports (eg svn+ssh://), you must include the username in
 	the URL, eg svn+ssh://foo@svn.bar.com/project
 
---prefix=<prefix>
+--prefix=<prefix>::
 	This allows one to specify a prefix which is prepended
 	to the names of remotes if trunk/branches/tags are
 	specified.  The prefix does not automatically include a
@@ -94,16 +94,16 @@ COMMANDS
 	This fetches revisions from the SVN parent of the current HEAD
 	and rebases the current (uncommitted to SVN) work against it.
 
-	This works similarly to 'svn update' or 'git-pull' except that
-	it preserves linear history with 'git-rebase' instead of
-	'git-merge' for ease of dcommit-ing with git-svn.
+This works similarly to 'svn update' or 'git-pull' except that
+it preserves linear history with 'git-rebase' instead of
+'git-merge' for ease of dcommit-ing with git-svn.
 
-	This accepts all options that 'git-svn fetch' and 'git-rebase'
-	accepts.  However '--fetch-all' only fetches from the current
-	[svn-remote], and not all [svn-remote] definitions.
+This accepts all options that 'git-svn fetch' and 'git-rebase'
+accepts.  However '--fetch-all' only fetches from the current
+[svn-remote], and not all [svn-remote] definitions.
 
-	Like 'git-rebase'; this requires that the working tree be clean
-	and have no uncommitted changes.
+Like 'git-rebase'; this requires that the working tree be clean
+and have no uncommitted changes.
 
 'dcommit'::
 	Commit each diff from a specified head directly to the SVN
@@ -117,29 +117,40 @@ COMMANDS
 	alternative to HEAD.
 	This is advantageous over 'set-tree' (below) because it produces
 	cleaner, more linear history.
+--
 
 'log'::
 	This should make it easy to look up svn log messages when svn
 	users refer to -r/--revision numbers.
++
+The following features from `svn log' are supported:
++
+--
+--revision=<n>[:<n>];;
+	is supported, non-numeric args are not:
+	HEAD, NEXT, BASE, PREV, etc ...
+-v/--verbose;;
+	it's not completely compatible with the --verbose
+	output in svn log, but reasonably close.
+--limit=<n>;;
+	is NOT the same as --max-count, doesn't count
+	merged/excluded commits
+--incremental;;
+	supported
+--
++
+New features:
++
+--
+--show-commit;;
+	shows the git commit sha1, as well
+--oneline;;
+	our version of --pretty=oneline
+--
++
+Any other arguments are passed directly to `git log'
 
-	The following features from `svn log' are supported:
-
-	--revision=<n>[:<n>] - is supported, non-numeric args are not:
-	                       HEAD, NEXT, BASE, PREV, etc ...
-	-v/--verbose         - it's not completely compatible with
-	                       the --verbose output in svn log, but
-			       reasonably close.
-	--limit=<n>          - is NOT the same as --max-count,
-	                       doesn't count merged/excluded commits
-	--incremental        - supported
-
-	New features:
-
-	--show-commit        - shows the git commit sha1, as well
-	--oneline            - our version of --pretty=oneline
-
-	Any other arguments are passed directly to `git log'
-
+--
 'set-tree'::
 	You should consider using 'dcommit' instead of this command.
 	Commit specified commit or tree objects to SVN.  This relies on
@@ -256,16 +267,18 @@ config key: svn.authorsfile
 	Make git-svn less verbose.
 
 --repack[=<n>]::
---repack-flags=<flags>
-	These should help keep disk usage sane for large fetches
-	with many revisions.
+--repack-flags=<flags>::
+
+These should help keep disk usage sane for large fetches
+with many revisions.
 
-	--repack takes an optional argument for the number of revisions
-	to fetch before repacking.  This defaults to repacking every
-	1000 commits fetched if no argument is specified.
+--repack takes an optional argument for the number of revisions
+to fetch before repacking.  This defaults to repacking every
+1000 commits fetched if no argument is specified.
 
-	--repack-flags are passed directly to gitlink:git-repack[1].
+--repack-flags are passed directly to gitlink:git-repack[1].
 
+[verse]
 config key: svn.repack
 config key: svn.repackflags
 
@@ -323,28 +336,30 @@ CONFIG FILE-ONLY OPTIONS
 
 svn.noMetadata::
 svn-remote.<name>.noMetadata::
-	This gets rid of the git-svn-id: lines at the end of every commit.
 
-	If you lose your .git/svn/git-svn/.rev_db file, git-svn will not
-	be able to rebuild it and you won't be able to fetch again,
-	either.  This is fine for one-shot imports.
+This gets rid of the git-svn-id: lines at the end of every commit.
+
+If you lose your .git/svn/git-svn/.rev_db file, git-svn will not
+be able to rebuild it and you won't be able to fetch again,
+either.  This is fine for one-shot imports.
 
-	The 'git-svn log' command will not work on repositories using
-	this, either.  Using this conflicts with the 'useSvmProps'
-	option for (hopefully) obvious reasons.
+The 'git-svn log' command will not work on repositories using
+this, either.  Using this conflicts with the 'useSvmProps'
+option for (hopefully) obvious reasons.
 
 svn.useSvmProps::
 svn-remote.<name>.useSvmProps::
-	This allows git-svn to re-map repository URLs and UUIDs from
-	mirrors created using SVN::Mirror (or svk) for metadata.
 
-	If an SVN revision has a property, "svm:headrev", it is likely
-	that the revision was created by SVN::Mirror (also used by SVK).
-	The property contains a repository UUID and a revision.  We want
-	to make it look like we are mirroring the original URL, so
-	introduce a helper function that returns the original identity
-	URL and UUID, and use it when generating metadata in commit
-	messages.
+This allows git-svn to re-map repository URLs and UUIDs from
+mirrors created using SVN::Mirror (or svk) for metadata.
+
+If an SVN revision has a property, "svm:headrev", it is likely
+that the revision was created by SVN::Mirror (also used by SVK).
+The property contains a repository UUID and a revision.  We want
+to make it look like we are mirroring the original URL, so
+introduce a helper function that returns the original identity
+URL and UUID, and use it when generating metadata in commit
+messages.
 
 svn.useSvnsyncProps::
 svn-remote.<name>.useSvnsyncprops::
@@ -369,8 +384,8 @@ section because they affect the 'git-svn-id:' metadata line.
 
 --
 
-Basic Examples
-~~~~~~~~~~~~~~
+BASIC EXAMPLES
+--------------
 
 Tracking and contributing to a the trunk of a Subversion-managed project:
 
-- 
1.5.0.2.285.g5347
Eric Wong· Mar 1, 2007, 20:38 UTC · re: Sergey Vlasov · lore

Re: [PATCH 4/4] Documentation/git-svn.txt: Fix formatting errors

Sergey Vlasov <vsu@altlinux.ru> wrote:
Show 8 quoted lines
> Fix some formatting problems:
> 
>   - Some list labels were missing their "::" characters.
>   - Some of continuation paragraphs in labeled lists were incorrectly
>     formatted as literal paragraphs.
>   - In one case "[verse]" was missing before the config key list.
>   - The "Basic Examples" section was incorrectly nested inside the
>     "Config File-Only Options" section.

Thanks. However, are the indentation changes in the source absolutely necessary for asciidoc to correctly format these things? I try to avoid building the docs because my computers are too slow.

If so:
Acked-by: Eric Wong <normalperson@yhbt.net>
> Signed-off-by: Sergey Vlasov <vsu@altlinux.ru>
> Cc: Eric Wong <normalperson@yhbt.net>
-- 
Eric Wong
Sergey Vlasov· Mar 2, 2007, 18:23 UTC · re: Eric Wong · lore

Re: [PATCH 4/4] Documentation/git-svn.txt: Fix formatting errors

On Thu, Mar 01, 2007 at 12:38:33PM -0800, Eric Wong wrote:
Show 12 quoted lines
> Sergey Vlasov <vsu@altlinux.ru> wrote:
> > Fix some formatting problems:
> > 
> >   - Some list labels were missing their "::" characters.
> >   - Some of continuation paragraphs in labeled lists were incorrectly
> >     formatted as literal paragraphs.
> >   - In one case "[verse]" was missing before the config key list.
> >   - The "Basic Examples" section was incorrectly nested inside the
> >     "Config File-Only Options" section.
> 
> Thanks.  However, are the indentation changes in the source absolutely
> necessary for asciidoc to correctly format these things?

Yes - normally asciidoc formats indented text as literal paragraphs; only the first paragraph after "tag::" is processed specially. And using a "+" line inside a "--" block also does not work.

> I try to avoid building the docs because my computers are too slow.
Yes, asciidoc is slow, and xmlto (xsltproc) is even slower :(
Show 6 quoted lines
> If so:
> 
> Acked-by: Eric Wong <normalperson@yhbt.net>
> 
> > Signed-off-by: Sergey Vlasov <vsu@altlinux.ru>
> > Cc: Eric Wong <normalperson@yhbt.net>

← back to recent threads