Re: [PATCH] on-commit-messages: Quick intro on submitting patches using git tool
M. Schneider schrieb:
Hi,
as discussed with Sedat and a bit with Daniel I have prepared on
behalf of them a short quick howto to help newcomers to extend the
live-manual.
As I do it my first time I will be very glad to get some feedback in
case I am doing something not in such way you would expect - thank you
in advance.
Regards,
Mark
ps. see the attached patch
and now the patch file ...
--
IT-Infrastrukturen.ORG
ms@it-infrastrukturen.org
http://www.it-infrastrukturen.org
+++ Free infrastructure software for all. +++
>From 9de1566f319e5497b78c9a5295784ce12f57aec9 Mon Sep 17 00:00:00 2001
From: Mark Schneider <ms@it-infrastrukturen.org>
Date: Sun, 5 Sep 2010 20:42:42 +0200
Subject: [PATCH] on-commit-messages: Quick intro on submitting patches using git tool
---
manual/en/live-manual.ssm | 2 +
.../other_quick-intro-submitting-git-patches.ssi | 109 ++++++++++++++++++++
2 files changed, 111 insertions(+), 0 deletions(-)
create mode 100644 manual/en/other_quick-intro-submitting-git-patches.ssi
diff --git a/manual/en/live-manual.ssm b/manual/en/live-manual.ssm
index 1d361d8..d4d4826 100644
--- a/manual/en/live-manual.ssm
+++ b/manual/en/live-manual.ssm
@@ -71,6 +71,8 @@
<< other_use-cases.ssi
+<< other_quick-intro-submitting-git-patches.ssi
+
<< other_success-stories.ssi
<< other_troubleshooting.ssi
diff --git a/manual/en/other_quick-intro-submitting-git-patches.ssi b/manual/en/other_quick-intro-submitting-git-patches.ssi
new file mode 100644
index 0000000..99f32f4
--- /dev/null
+++ b/manual/en/other_quick-intro-submitting-git-patches.ssi
@@ -0,0 +1,109 @@
+B~ Quick intro on submitting patches using git tool
+
+1~ Quick intro on submitting patches using git tool
+
+This chapter documents environment and git settings required to edit live-manual and to apply modificatinos to the git repo.
+
+2~ Setting of local user
+
+The settting can occure in $HOME/.bashrc or $HOME/.gitconfig
+
+3~ $HOME/.bashrc
+
+code{
+
+# git-config settings
+export GIT_AUTHOR_NAME="Your Name Comes Here"
+export GIT_AUTHOR_EMAIL="you@yourdomain.example.org"
+export GIT_COMMITTER_NAME="Your Name Comes Here"
+export GIT_COMMITTER_EMAIL="you@yourdomain.example.org"
+
+}code
+
+3~ $HOME/.gitconfig
+
+code{
+
+[user]
+ name = Your Name Comes Here
+ email = you@yourdomain.example.com
+
+}code
+
+2~ Create an own GIT branch of desired documment
+
+code{
+
+mkdir -p SRC/live-manual; cd SRC/live-manual
+# crealte a local copy of git repo
+git clone git://live.debian.net/git/live-manual.git
+cd live-manual/
+git branch -l
+git branch -r
+
+# create an own git branch
+git branch on-commit-messages
+# Change to the own git branch
+# (switch to branch 'on-commit-messages')
+git branch -l
+git checkout on-commit-messages
+# git checkout -b on-commit-messages
+
+# edit the required file
+vi manual/en/other_quick-intro-submitting-git-patches.ssi
+
+# Create git diff
+git diff manual/en/other_quick-intro-submitting-git-patches.ssi
+git diff manual/en/other_quick-intro-submitting-git-patches.ssi | cat
+git add manual/en/other_quick-intro-submitting-git-patches.ssi
+git commit -a
+
+# create a patch of the last commit
+git format-patch -1
+# Modifying again
+git commit --amend
+
+}code
+
+ironm@ppc:~/SRC/live-manual/live-manual$ git commit -a
+
+code{
+
+[on-commit-messages 650de8c] on-commit-messages: Quick intro on submitting patches using git tool
+ 1 files changed, 30 insertions(+), 15 deletions(-)
+
+}code
+
+
+ironm@ppc:~/SRC/live-manual/live-manual$ git branch -l
+
+code{
+
+ debian
+* on-commit-messages
+
+}code
+
+Please send the output of 'git diff' (like 0001-quick-intro-on-submitting-patches-using-git-tool.patch) to the mailinglist (debian-live@lists.debian.org) to discuss proposed changes.
+
+2~ HELPFUL REFERENCES
+
+http://www.kernel.org/pub/software/scm/git/docs/user-manual.html
+
+http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#telling-git-your-name
+
+http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#how-to-get-a-git-repository
+
+http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#repositories-and-branches
+
+http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#how-to-make-a-commit
+
+http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#submitting-patches
+
+2~ FAQ modifying of live-manual sources
+
+Do I need to add such words like "'Fixing/Adding/Removing/Correcting/" in front of every change I have made in the source of live-manual?
+
+<dba> if you do single fixes, yes. if you rework/update a whole chapter, then you commit one chapter. Read http://repo.or.cz/w/git.git?a=blob;f=Documentation/SubmittingPatches;hb=HEAD
+
+FIXME
--
1.7.1
Reply to: