git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] sanitize content of README file

From
Junio C Hamano <junkio@cox.net>
Date
Jan 17, 2007, 19:39 UTC
Message-ID
<7vtzypqw6s.fsf@assigned-by-dhcp.cox.net>
In-Reply-To
<Pine.LNX.4.64.0701171255150.2577@xanadu.home>

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
 -------
Previous: Nicolas Pitre
Message 2 of 2 in “sanitize content of README file”
  1. sanitize content of README fileNicolas Pitre, Jan 17, 2007
  2. Junio C HamanoJan 17, 2007

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.