[PATCH v2 0/2] git-p4: fix AsciiDoc formatting

[PATCH v2 0/2] git-p4: fix AsciiDoc formatting

[larsxschneider]

From: Lars Schneider <larsxschneider@gmail.com>

diff to v1:
* reference external pages similar to git-bisect-lk2009 (thanks Luke)
* fix quotation marks (you can see the error here:
  https://git-scm.com/docs/git-p4/2.7.4 ... search for cp1252 )

Thanks,
Lars


Lars Schneider (2):
  Documentation: fix git-p4 AsciiDoc formatting
  Documentation: use ASCII quotation marks in git-p4

 Documentation/git-p4.txt | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

--
2.5.1

[PATCH v2 1/2] Documentation: fix git-p4 AsciiDoc formatting

[larsxschneider]

From: Lars Schneider <larsxschneider@gmail.com>

Noticed-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Lars Schneider <larsxschneider@gmail.com>
---
 Documentation/git-p4.txt | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index 738cfde..6457634 100644
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -520,15 +520,13 @@ git-p4.pathEncoding::
 git-p4.largeFileSystem::
 	Specify the system that is used for large (binary) files. Please note
 	that large file systems do not support the 'git p4 submit' command.
-	Only Git LFS [1] is implemented right now. Download
+	Only Git LFS <<1>> is implemented right now. Download
 	and install the Git LFS command line extension to use this option
 	and configure it like this:
 +
 -------------
 git config       git-p4.largeFileSystem GitLFS
 -------------
-+
-	[1] https://git-lfs.github.com/
 
 git-p4.largeFileExtensions::
 	All files matching a file extension in the list will be processed
@@ -626,3 +624,8 @@ IMPLEMENTATION DETAILS
   message indicating the p4 depot location and change number.  This
   line is used by later 'git p4 sync' operations to know which p4
   changes are new.
+
+REFERENCES
+----------
+
+- [[[1]]] https://git-lfs.github.com/[Git LFS - An open source Git extension for versioning large files]
-- 
2.5.1

[PATCH v2 2/2] Documentation: use ASCII quotation marks in git-p4

[larsxschneider]

From: Lars Schneider <larsxschneider@gmail.com>

Signed-off-by: Lars Schneider <larsxschneider@gmail.com>
---
 Documentation/git-p4.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index 6457634..8afb31d 100644
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -515,7 +515,7 @@ git-p4.pathEncoding::
 	Git expects paths encoded as UTF-8. Use this config to tell git-p4
 	what encoding Perforce had used for the paths. This encoding is used
 	to transcode the paths to UTF-8. As an example, Perforce on Windows
-	often uses “cp1252” to encode path names.
+	often uses "cp1252" to encode path names.
 
 git-p4.largeFileSystem::
 	Specify the system that is used for large (binary) files. Please note
-- 
2.5.1

Re: [PATCH v2 0/2] git-p4: fix AsciiDoc formatting

[Junio C Hamano]

larsxschneider@gmail.com writes:

> From: Lars Schneider <larsxschneider@gmail.com>
>
> diff to v1:
> * reference external pages similar to git-bisect-lk2009 (thanks Luke)
> * fix quotation marks (you can see the error here:
>   https://git-scm.com/docs/git-p4/2.7.4 ... search for cp1252 )
>
> Thanks,
> Lars
>
>
> Lars Schneider (2):
>   Documentation: fix git-p4 AsciiDoc formatting
>   Documentation: use ASCII quotation marks in git-p4
>
>  Documentation/git-p4.txt | 11 +++++++----
>  1 file changed, 7 insertions(+), 4 deletions(-)

Hmph, this seems to break my build.

xmlto: /home/gitster/w/git.git/Documentation/git-p4.xml does not validate (status 3)
xmlto: Fix document syntax or use --skip-validation option
/home/gitster/w/git.git/Documentation/git-p4.xml:812: element xref: validity error : Syntax of value for attribute linkend of xref is not valid
/home/gitster/w/git.git/Documentation/git-p4.xml:1077: element anchor: validity error : Syntax of value for attribute id of anchor is not valid
Document /home/gitster/w/git.git/Documentation/git-p4.xml does not validate


On line #812 of the generated file I see this:

        Only Git LFS <xref linkend="1"/> is implemented right now. Download

And line #1077 I see this:

<anchor id="1" xreflabel="[1]"/>[1] <ulink url="https://git-lfs.github.com/">Git LFS - An open source Git extension for versioning large files</ulink>

It could be that mimicking git-bisect-lk2009 that never is formatted
as manpage is a bad idea to begin with?

$ xmlto --version
xmlto version 0.0.25