[PATCH] Git release notes man page

DORMANTno replies

2 messages, 1 author, 2016-06-15 · open the first message on its own page

[PATCH] Git release notes man page

From: Philip Oakley <hidden>
Date: 2016-06-15 22:59:55

A few days too late for the 1.9.0 release cycle :(

This responds to Stefan Näwe's request for a 'git help' command that would
access the release notes. ($gmane/240595 17 Jan 2014).

I've used the full name "release-notes" for the help guide rather than
Stefan's original 'git help relnotes'.

The release-notes man page lists just the notes for the current release.
The combined notes for all releases is nearing 15k lines.

The one formatting niggle is that the included text is column shifted
such that the the raw text now starts at col 12 for the man page and
reaches past col 80. Is there an attribute setting to not indent the
included block text within a man page? It looks fine in --web format.

I used the code.google link, rather than kernel.org, for the previous
release notes to match the link currently used in git(1).

Philip Oakley (1):
  Provide a release-notes man page / guide

 Documentation/Makefile             |  1 +
 Documentation/gitrelease-notes.txt | 37 +++++++++++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+)
 create mode 100644 Documentation/gitrelease-notes.txt

-- 
1.8.3.msysgit.0

[PATCH] [PATCH] Provide a release-notes man page / guide

From: Philip Oakley <hidden>
Date: 2016-06-15 22:59:55

Use the symlinked RelNote file as a list-block to
act as the core of the release-notes man page.

The mantainers work load should not be affected.

Signed-off-by: Philip Oakley <redacted>
---

The included lines are inset 11 spaces by the man page
asciidoc formatting so some are more than 80 characters long.
No negative indent mechanism for the list block was found -
suggestions welcomed.

The use of the stalenotes section from git(1) was rejected.

The stalenotes, with over two hundred links, has greater than
2 digits allowed in the trailing link list on the man page,
so would miss the hundreds digit.

Also the html links for the "documentation for release x.y.z"
(at kerenel.org) are to html files that are not actually made
by the makefile.
---
 Documentation/Makefile             |  1 +
 Documentation/gitrelease-notes.txt | 37 +++++++++++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+)
 create mode 100644 Documentation/gitrelease-notes.txt
diff --git a/Documentation/Makefile b/Documentation/Makefile
index fc6b2cf..b599b1f 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -29,6 +29,7 @@ MAN7_TXT += gitdiffcore.txt
 MAN7_TXT += gitglossary.txt
 MAN7_TXT += gitnamespaces.txt
 MAN7_TXT += gitrevisions.txt
+MAN7_TXT += gitrelease-notes.txt
 MAN7_TXT += gittutorial-2.txt
 MAN7_TXT += gittutorial.txt
 MAN7_TXT += gitworkflows.txt
diff --git a/Documentation/gitrelease-notes.txt b/Documentation/gitrelease-notes.txt
new file mode 100644
index 0000000..29d9b1b
--- /dev/null
+++ b/Documentation/gitrelease-notes.txt
@@ -0,0 +1,37 @@
+gitrelease-notes(7)
+===================
+
+NAME
+----
+gitrelease-notes - the onward progress of the stupid content tracker
+
+
+SYNOPSIS
+--------
+[verse]
+'git help release-notes'
+
+DESCRIPTION
+-----------
+
+Provide the release notes for the latest (possibly
+unreleased) version of Git, that is available from 'master'
+branch of the `git.git` repository.
+
+RELEASE NOTES
+-------------
+
+----
+include::../RelNotes[]
+----
+
+OLDER RELEASE NOTES
+-------------------
+
+Release notes for older versions are available in the Git source
+Documentation/RelNotes/ folder. This is currently available at
+https://code.google.com/p/git-core/source/browse/
+
+GIT
+---
+Part of the linkgit:git[1] suite
-- 
1.8.3.msysgit.0
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help