[PATCH] Documentation: fix git-clone manpage not to refer to itself

[PATCH] Documentation: fix git-clone manpage not to refer to itself

[Sergei Organov]

Signed-off-by: Sergei Organov <osv@javad.com>
---
 Documentation/git-clone.txt |    1 +
 Documentation/urls.txt      |    6 ++++++
 2 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 14e58f3..c90bcec 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -130,6 +130,7 @@ OPTIONS
 	for "host.xz:foo/.git").  Cloning into an existing directory
 	is not allowed.
 
+:git-clone: 1
 include::urls.txt[]
 
 Examples
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index e67f914..4f66738 100644
--- a/Documentation/urls.txt
+++ b/Documentation/urls.txt
@@ -36,5 +36,11 @@ To sync with a local directory, you can use:
 - file:///path/to/repo.git/
 ===============================================================
 
+ifndef::git-clone[]
 They are mostly equivalent, except when cloning.  See
 gitlink:git-clone[1] for details.
+endif::git-clone[]
+
+ifdef::git-clone[]
+They are equivalent, except the former implies --local option.
+endif::git-clone[]
-- 
1.5.3.4

Re: [PATCH] Documentation: fix git-clone manpage not to refer to itself

[Johannes Schindelin]

Hi,

On Fri, 16 Nov 2007, Sergei Organov wrote:

> +ifndef::git-clone[]

It is laudable that you want to fix the _generated_ documentation, but 
there are two things to keep in mind:

- it does _nothing_ to help readers of the sources, and asciidoc was 
  chosen purposely because the source is human-readable, and

- it makes writing the perl script to do a very tiny subset of asciidoc 
  formatting much harder.  We encounter enough problems with the different 
  versions of asciidoc/docbook combinations that I think this perl script 
  would be actually useful.

I know that the user manual uses some advanced features, too, but it did 
not use ifdef in the main text, for example, let alone nested ifdefs, 
which your patch would encourage much more than the source before.

Ciao,
Dscho

Re: [PATCH] Documentation: fix git-clone manpage not to refer to itself

[Jakub Narebski]

Johannes Schindelin wrote:

> On Fri, 16 Nov 2007, Sergei Organov wrote:
> 
>> +ifndef::git-clone[]
> 
> It is laudable that you want to fix the _generated_ documentation, but 
> there are two things to keep in mind:
> 
> - it does _nothing_ to help readers of the sources, and asciidoc was 
>   chosen purposely because the source is human-readable, and

IMHO it doesn't make source of documentation less readable.

It has the advantage of not duplicating contents, and being a bit mre
readable than writing "for <cmd>" in documentation contents.

-- 
Jakub Narebski
Warsaw, Poland
ShadeHawk on #git

Re: [PATCH] Documentation: fix git-clone manpage not to refer to itself

[Sergei Organov]

Johannes Schindelin <Johannes.Schindelin@gmx.de> writes:
> Hi,
>
> On Fri, 16 Nov 2007, Sergei Organov wrote:
>
>> +ifndef::git-clone[]
>
> It is laudable that you want to fix the _generated_ documentation, but 
> there are two things to keep in mind:
>
> - it does _nothing_ to help readers of the sources, and asciidoc was 
>   chosen purposely because the source is human-readable, and

I wonder if C sources are human-readable? No #ifdefs whatsoever? ;)

And please notice that asciidoc is much worse than C preprocessor in
this regard :(

>
> - it makes writing the perl script to do a very tiny subset of asciidoc 
>   formatting much harder.  We encounter enough problems with the different 
>   versions of asciidoc/docbook combinations that I think this perl script 
>   would be actually useful.
>
> I know that the user manual uses some advanced features, too, but it did 
> not use ifdef in the main text, for example, let alone nested ifdefs, 
> which your patch would encourage much more than the source before.

Unfortunately I don't see better solution than using ifdef in this
particular case, though I'm open for suggestions.

What I really do care about is the quality of the documentation that
user reads. For example, when the first option of git-format-*patch*
described in the manual is "-p Generate *patch*...", well..., what does
it generate without -p???

-- 
Sergei.

Re: [PATCH] Documentation: fix git-clone manpage not to refer to itself

[Wincent Colaiuta]

[-- Attachment #1: Type: text/plain, Size: 1135 bytes --]

El 19/11/2007, a las 14:35, Johannes Schindelin escribió:

> - it makes writing the perl script to do a very tiny subset of  
> asciidoc
>  formatting much harder.  We encounter enough problems with the  
> different
>  versions of asciidoc/docbook combinations that I think this perl  
> script
>  would be actually useful.
>
> I know that the user manual uses some advanced features, too, but it  
> did
> not use ifdef in the main text, for example, let alone nested ifdefs,
> which your patch would encourage much more than the source before.

Out of curiosity, have you done any more work on that WIP AsciiDoc  
replacement since you last wrote to the list about it back in October?

I'm on a new OS install now, so just yesterday and today I had to set  
up the AsciiDoc/DocBook/xmlto toolchain again, and was reminded of how  
painful it was. At least on Mac OS X, it requires installing a bunch  
of dependencies (and specific versions of them otherwise it won't  
work), hacking Makefiles, installing a bunch of XSL and DTDs, and  
setting up XML catalogs. Doable but annoying.

Cheers,
Wincent



[-- Attachment #2: smime.p7s --]
[-- Type: application/pkcs7-signature, Size: 2413 bytes --]

Re: [PATCH] Documentation: fix git-clone manpage not to refer to itself

[Johannes Schindelin]

Hi,

On Tue, 20 Nov 2007, Wincent Colaiuta wrote:

> El 19/11/2007, a las 14:35, Johannes Schindelin escribi?:
> 
> > - it makes writing the perl script to do a very tiny subset of 
> > asciidoc formatting much harder.  We encounter enough problems with 
> > the different versions of asciidoc/docbook combinations that I think 
> > this perl script would be actually useful.
> > 
> > I know that the user manual uses some advanced features, too, but it 
> > did not use ifdef in the main text, for example, let alone nested 
> > ifdefs, which your patch would encourage much more than the source 
> > before.
> 
> Out of curiosity, have you done any more work on that WIP AsciiDoc 
> replacement since you last wrote to the list about it back in October?

Yes.  I rewrote it three times, and the third time is not finished, but 
slowed down to a glacial pace.  You can see the continental shift at my 
repository on repo.or.cz (it's the "dscho" fork of git.git).

Ciao,
Dscho