From: Philip Oakley <philipoakley@iee.org>
To: GitList <git@vger.kernel.org>
Subject: [PATCH 06/13] Add guide-list.txt and extraction shell
Date: Sat, 23 Feb 2013 23:05:54 +0000 [thread overview]
Message-ID: <1361660761-1932-7-git-send-email-philipoakley@iee.org> (raw)
In-Reply-To: <1361660761-1932-1-git-send-email-philipoakley@iee.org>
The guide-list.txt uses exactly the same format as command-list.txt
so could be merged as part of a refactoring.
The category naming for each guide is an initial suggestion and
is not yet used. Only those with the 'guide' prefix are copied
by the generate-guidelist.sh into the common-guides.h file.
The user-manual.txt and everyday.txt do not have the correct filename
format yet. And gitrepository-layout.txt name is too long to include.
So comment them out.
Signed-off-by: Philip Oakley <philipoakley@iee.org>
---
The shell script function N_() does not appear to work correctly on my
Ubuntu lash-up, so an simpler script line is used with the original
commented out.
---
generate-guidelist.sh | 23 +++++++++++++++++++++++
guide-list.txt | 29 +++++++++++++++++++++++++++++
2 files changed, 52 insertions(+)
create mode 100644 generate-guidelist.sh
create mode 100644 guide-list.txt
diff --git a/generate-guidelist.sh b/generate-guidelist.sh
new file mode 100644
index 0000000..c0c98eb
--- /dev/null
+++ b/generate-guidelist.sh
@@ -0,0 +1,23 @@
+#!/bin/sh
+# Usage: ./generate-guidelist.sh >>common-guides.h
+# based on generate-cmdlist.sh
+echo "/* Automatically generated by $0 */
+/* re-use struct cmdname_help in common-commands.h */
+
+static struct cmdname_help common_guides[] = {"
+
+sed -n -e 's/^git\([^ ]*\)[ ].* guide.*/\1/p' guide-list.txt |
+sort |
+while read guide
+do
+ sed -n '
+ /^NAME/,/git'"$guide"'/H
+ ${
+ x
+# s/.*git'"$guide"' - \(.*\)/ {"'"$guide"'", N_("\1")},/
+ s/.*git'"$guide"' - \(.*\)/ {"'"$guide"'", "\1"},/
+ p
+ }' "Documentation/git$guide.txt"
+done
+echo "};"
+
diff --git a/guide-list.txt b/guide-list.txt
new file mode 100644
index 0000000..a419ac4
--- /dev/null
+++ b/guide-list.txt
@@ -0,0 +1,29 @@
+# List of known git guides.
+# guide name category [deprecated] [common] [guide]
+gitattributes concept guide
+gitcore-tutorial specialist
+gitcredentials specialist
+gitcvs-migration specialist
+gitdiffcore specialist
+gitglossary reference guide
+githooks specialist
+gitignore concept guide
+gitmodules concept guide
+gitnamespaces specialist
+#gitrepository-layout reference guide
+gitrevisions concept guide
+gittutorial user guide
+gittutorial-2 user
+gitweb.conf specialist
+gitweb specialist
+gitworkflows user guide
+
+#giteveryday user guide
+#gituser-manual user guide
+
+# could embed inside common-cmds.h with [guide] as the second thing,
+# making the sed's in generate-cmdlist.sh more obvious
+# but drop the dash in 's/^git-\
+
+#gitrepository-layout is too long for the current char[16]
+#
--
1.8.1.msysgit.1
next prev parent reply other threads:[~2013-02-23 23:06 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-02-23 23:05 [PATCH 00/13] Git help option to list user guides Philip Oakley
2013-02-23 23:05 ` [PATCH 01/13] Use 'Git' in help messages Philip Oakley
2013-02-23 23:41 ` David Aguilar
2013-02-23 23:54 ` Philip Oakley
2013-02-24 8:59 ` Junio C Hamano
2013-02-24 21:50 ` Philip Oakley
2013-02-24 22:11 ` David Aguilar
2013-02-23 23:05 ` [PATCH 02/13] Show 'git help <guide>' usage, with examples Philip Oakley
2013-02-24 14:39 ` W. Trevor King
2013-02-24 22:05 ` Philip Oakley
2013-02-23 23:05 ` [PATCH 03/13] Help.c use OPT_COUNTUP Philip Oakley
2013-02-23 23:05 ` [PATCH 04/13] Help.c add --guide option Philip Oakley
2013-02-23 23:05 ` [PATCH 05/13] Help.c: add list_common_guides_help() function Philip Oakley
2013-02-24 9:01 ` Junio C Hamano
2013-02-24 21:51 ` Philip Oakley
2013-02-25 5:24 ` Junio C Hamano
2013-02-25 23:43 ` Philip Oakley
2013-02-25 23:55 ` Junio C Hamano
2013-02-23 23:05 ` Philip Oakley [this message]
2013-02-24 14:51 ` [PATCH 06/13] Add guide-list.txt and extraction shell W. Trevor King
2013-02-24 22:12 ` Philip Oakley
2013-02-23 23:05 ` [PATCH 07/13] Extend name string for longer names Philip Oakley
2013-02-23 23:05 ` [PATCH 09/13] Rename everyday to giteveryday Philip Oakley
2013-02-24 14:55 ` W. Trevor King
2013-02-24 22:16 ` Philip Oakley
2013-02-23 23:05 ` [PATCH 10/13] Update Git(1) links to guides Philip Oakley
2013-02-23 23:05 ` [PATCH 11/13] Add missing guides to list and regenerate Philip Oakley
2013-02-23 23:06 ` [PATCH 12/13] Documentation/Makefile: update git guide links Philip Oakley
2013-02-24 14:58 ` W. Trevor King
2013-02-24 22:31 ` Philip Oakley
2013-02-25 5:29 ` Junio C Hamano
2013-02-25 23:43 ` Philip Oakley
2013-02-26 0:04 ` Junio C Hamano
2013-02-26 20:24 ` Philip Oakley
2013-02-23 23:06 ` [PATCH 13/13] Fixup! doc: giteveryday and user-manual man format Philip Oakley
2013-02-24 15:01 ` W. Trevor King
2013-02-24 22:32 ` Philip Oakley
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1361660761-1932-7-git-send-email-philipoakley@iee.org \
--to=philipoakley@iee.org \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).