Thread (1 message) 1 message, 1 author, 2016-06-15

Re: [PATCH] sanitize content of README file

From: Junio C Hamano <hidden>
Date: 2016-06-15 22:42:49
Subsystem: documentation, the rest · Maintainers: Jonathan Corbet, Linus Torvalds

Possibly related (same subject, not in this thread)

I do not think it is a bad idea to make the top-level README
concise and sweet, but this has fallout in Documentation/git.txt
which includes README and makes it into the Discussion section.

The attached patch on top of yours would resurrect it.

---
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 93c7024..9f2d242 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -71,14 +71,11 @@ doc.dep : $(wildcard *.txt) build-docdep.perl
 
 -include doc.dep
 
-git.7: README
-
-README: ../README
-	cp $< $@
+git.7 git.html: git.txt core-intro.txt
 
 
 clean:
-	rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html doc.dep README
+	rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html doc.dep
 
 %.html : %.txt
 	asciidoc -b xhtml11 -d manpage -f asciidoc.conf $<
@@ -89,8 +86,6 @@ clean:
 %.xml : %.txt
 	asciidoc -b docbook -d manpage -f asciidoc.conf $<
 
-git.html: git.txt README
-
 glossary.html : glossary.txt sort_glossary.pl
 	cat $< | \
 	perl sort_glossary.pl | \
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 6a82803..a0bcef7 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -699,7 +699,7 @@ other
 
 Discussion[[Discussion]]
 ------------------------
-include::README[]
+include::core-intro.txt[]
 
 Authors
 -------
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help