From 6af23c2bb403323fef33e830770c832616a7911b Mon Sep 17 00:00:00 2001 From: Michael Prokop Date: Fri, 18 Jun 2010 11:06:02 +0200 Subject: docs/maintainer-notes: valid XHTML 1.0 Strict document, add section "Build snapshot version", add license note, minor formating cleanups + improvements Signed-off-by: Michael Prokop --- docs/maintainer-notes.html | 122 +++++++++++++++++++++++++++++++-------------- 1 file changed, 84 insertions(+), 38 deletions(-) (limited to 'docs/maintainer-notes.html') diff --git a/docs/maintainer-notes.html b/docs/maintainer-notes.html index 3bda045..e8d36ea 100644 --- a/docs/maintainer-notes.html +++ b/docs/maintainer-notes.html @@ -12,8 +12,6 @@ acronym { cursor: help; } body { font-family: "DejaVu Sans", "Bitstream Vera Sans", sans-serif; } pre { background-color: #EEEEEE; border: 1px dashed black; padding: 1em; } div.right { text-align: right; } -red { color: red; } -gray { color: gray; } /*]]>*/ @@ -39,29 +37,34 @@ gray { color: gray; }
  • 3.1 Implement new features
  • 3.2 Merge branches
  • 3.3 Test specific branch
    • +
  • 3.4 Build snapshot version
  • 4. Contribute
    • -
  • 5 Releasing new version
    • -
  • 6 Ressources
    • -
  • 7 Credits
    • - +
  • 5. Release new version
    • +
  • 6. Ressources
    • +
  • 7. Credits
    • +
  • 8. License
    • -

    1. Definitions

    +

    NOTE: The most recent version of this document is available at +docs/maintainer-notes.html in the the git repository +or online at git.debian.org.

    -

    - Note: This cheatpage assumes that you are using git-core 1.5.6 or newer. -

    +
    + +

    1. Definitions

    - - - + + + +
    version:version string
    username:name of the alioth account
    mailaddress:mailaddress of the user
    $mailaddress:mailaddress of the user
    $username:name of the alioth account
    $version:version string
    $yourname:your fullname
    ^
    @@ -79,13 +82,16 @@ gray { color: gray; }
  • Set environment variables (e.g. through your ~/.bashrc or ~/.zshrc) for git and git-dch: 
    -% export GIT_AUTHOR_EMAIL=<mailaddress>
-% export DEBEMAIL=<mailaddress>
-% export GIT_COMMITTER_EMAIL=<mailaddress>
+export DEBEMAIL=$mailaddress
+export DEBFULLNAME=$yourname
+export GIT_AUTHOR_EMAIL=$mailaddress
+export GIT_AUTHOR_NAME=$yourname
+export GIT_COMMITTER_EMAIL=$mailaddress
+export GIT_COMMITTER_NAME=$yourname
    • -
  • Checkout repository (anonymous): +
  • Checkout repository (anonymous): 
     % git clone git://git.debian.org/git/kernel/initramfs-tools.git
 % cd initramfs-tools
@@ -94,7 +100,7 @@ gray { color: gray; }
 
 
  • Checkout repository (with developer access):
 
    -% git clone ssh://username@git.debian.org/git/kernel/initramfs-tools.git
+% git clone ssh://$username@git.debian.org/git/kernel/initramfs-tools.git
 % cd initramfs-tools
 
    
 
    • 
@@ -112,7 +118,7 @@ gray { color: gray; }
 
 
  • Checkout new branch and switch to it:
 
    -% git checkout -b username/short-descr-of-new-feature
+% git checkout -b $username/short-descr-of-new-feature
 
    
 
    • 
 
@@ -122,16 +128,17 @@ gray { color: gray; }
 % git add $somefile
 % git commit -s
    -
    • -

    NOTE: Use 'Closes: #BUGID' for closing a bugreport, 'Thanks: Name -<mailaddress>' for giving credits in your commit message. git-dch will use +NOTE: Use 'Closes: #BUGID' for closing a bugreport and 'Thanks: Fullname +<mailaddress>' for giving credits in your commit message. git-dch will use this information for generating the changelog using the --meta option later -on.

    +on. + +
  • Finally push your branch to alioth: 
    -% git push origin username/short-descr-of-new-feature
+% git push origin $username/short-descr-of-new-feature
    • @@ -143,7 +150,7 @@ on.

  • Switch to the branch you want to merge: 
    -% git checkout username/new-feature
+% git checkout $username/new-feature
    • @@ -156,7 +163,7 @@ on.

  • Switch to master branch and merge: 
     % git checkout master
-% git merge username/new-feature
+% git merge $username/new-feature
    • @@ -168,8 +175,8 @@ on.

  • After branch is merged delete branch on server and locally: 
    -% git push origin :username/short-descr-of-new-feature
-% git branch -d username/short-descr-of-new-feature
+% git push origin :$username/short-descr-of-new-feature
+% git branch -d $username/short-descr-of-new-feature
    • @@ -202,9 +209,34 @@ on.

     % git-buildpackage --git-debian-branch="$(git branch | awk -F\*\  '/^* / { print $2}' )" -tc
    + + + + +
    ^
    +
    + +

    3.4 Build snapshot version

    + +
      + +
    1. Adjust debian/changelog accordingly: +
      +% git-dch --debian-branch="$(git branch | awk -F\*\   '/^* / { print $2}' )" \
+  --since="$(dpkg-parsechangelog | awk '/^Version:/ {print $2}')" -S --id-length=7 --meta
+
      +
      2. + +
    2. Build package: +
      +% git-buildpackage --git-debian-branch="$(git branch | awk -F\*\  '/^* / { print $2}' )" -tc [-us -uc]
+
      +
      3. +
    ^
    +

    4. Contribute

    @@ -213,23 +245,27 @@ on.

     % git format-patch -s -p origin/master
    +
  • Send patch file(s) to maintainers via mail (requires Debian package git-email): 
     % git send-email --to=initramfs-tools@packages.qa.debian.org $PATCHFILE[S]
    +
    • +
    ^
    +
    -

    5 Releasing new version

    +

    5. Release new version

    1. Creating changelog: 
      -% git-dch --debian-branch debian --release --since HASH
+% git-dch --debian-branch debian --release --since HASH
      or more dynamically: @@ -238,17 +274,21 @@ or more dynamically: % git-dch --meta --release --since v$(dpkg-parsechangelog | awk '/^Version:/ {print $2}') --debian-branch="$(git branch | awk -F\*\ '/^* / { print $2}' )" [--id-length=7] [--full] +NOTE: we do not use history based sorting for the changelog entries but +sort them by author (doing that manually when reviewing the changelog, see #586165). +
    2. Releasing: 
      -% git commit -a -s -m "Releasing debian version version."
+% git commit -a -s -m "Releasing version $version."
    3. Tagging: 
      -% git tag -s v"version" -m "release version"
+% git tag -s v"$version" -m "release $version"
      4. @@ -271,7 +311,7 @@ shortlog (generated through "git shortlog $TAG..").
      ^
      -

      Ressources

      +

      6. Ressources

      +
      ^
      +
      + +

      7. Credits

      + +
      ^
      -

      Credits

      +

      8. License

        -
      • Thanks to Daniel Baumann for his "Maintainer Cheatpage" which inspired this document
        • +
      • This document is licensed under GPL v2 or any later version.
      ^

      --- Michael Prokop <mika@debian.org> +-- Michael Prokop <mika@debian.org>

      - - -- cgit v1.2.3