[wiki] [PATCH] patches: unify the patches generation instructions

From: Quentin Rameau <quinq_AT_fifth.space>
Date: Fri, 17 Jun 2016 13:20:33 +0200

Instead of having a duplicate index for the patches of each tool, add
the instructions do the already existing hacking instructions and link
to it.
Custom instructions on the dwm patches page have been merge into the
the general instructions and related projects moved to the about page.
---
 dwm.suckless.org/index.md                  | 21 ++++++++++
 dwm.suckless.org/patches/index.md          | 63 +-----------------------------
 st.suckless.org/patches/index.md           |  5 +--
 suckless.org/hacking.md                    | 44 ++++++++++++++++++---
 surf.suckless.org/patches/index.md         | 31 +--------------
 tools.suckless.org/dmenu/patches/index.md  | 30 +-------------
 tools.suckless.org/ii/patches/index.md     | 30 +-------------
 tools.suckless.org/sent/patches/index.md   | 30 +-------------
 tools.suckless.org/sic/patches/index.md    | 30 +-------------
 tools.suckless.org/slock/patches/index.md  | 30 +-------------
 tools.suckless.org/tabbed/patches/index.md | 31 +--------------
 11 files changed, 68 insertions(+), 277 deletions(-)
 mode change 100644 => 120000 dwm.suckless.org/patches/index.md
 mode change 100644 => 120000 st.suckless.org/patches/index.md
 mode change 100644 => 120000 surf.suckless.org/patches/index.md
 mode change 100644 => 120000 tools.suckless.org/dmenu/patches/index.md
 mode change 100644 => 120000 tools.suckless.org/ii/patches/index.md
 mode change 100644 => 120000 tools.suckless.org/sent/patches/index.md
 mode change 100644 => 120000 tools.suckless.org/sic/patches/index.md
 mode change 100644 => 120000 tools.suckless.org/slock/patches/index.md
 mode change 100644 => 120000 tools.suckless.org/tabbed/patches/index.md
diff --git a/dwm.suckless.org/index.md b/dwm.suckless.org/index.md
index ad5b72e..a425e15 100644
--- a/dwm.suckless.org/index.md
+++ b/dwm.suckless.org/index.md
_AT_@ -102,3 +102,24 @@ Related discussion
 * <http://blog.yjl.im/2011/07/two-weeks-with-dwm.html>
 * <http://www.murga-linux.com/puppy/viewtopic.php?p=258224>
 * <http://opensourceforu.com/2012/03/tiling-window-managers-getting-started-with-dwm/>
+
+related projects
+----------------
+* [awesome](http://awesome.naquadah.org/) -- dwm fork with XCB, EWMH, Lua script, Xft, D-Bus, multihead.. support
+* [awm](http://www.freaknet.org/alpt/src/alpt-wm/readme) -- (old) modified dwm with workspaces and /proc like interface
+* [bwm](http://lists.suckless.org/dwm/0708/3085.html) -- (old) modified dwm with extensive mouse support
+* [cons-wm](http://github.com/dharmatech/psilab/tree/master/cons-wm) -- minimalist wm in scheme (not tiled)
+* [bug.n](https://github.com/fuhsjr00/bug.n) -- dwm for Windows written in AutoHotkey
+* [dvtm](http://www.brain-dump.org/projects/dvtm/) -- virtual terminal manager (dwm on the console)
+* [dwm-gtx](http://s01.de/~gottox/index.cgi/proj_dwm) -- dwm branch with Xinerama support, pointer movement, different layout
+* [dwm-sprinkles](http://0mark.unserver.de/dwm-sprinkles/) -- dwm with colorfull bar, transparency, pre-configured pertag and more
+* [dwm-win32](http://www.brain-dump.org/projects/dwm-win32/) -- dwm ported to windows
+* [echinus](http://www.rootshell.be/~polachok/code/) -- dwm fork with EWMH, Xft support
+* [gemini](http://gemini.digitalmediaplanet.net) -- terminal manager
+* [i3](http://i3.zekjur.net/) -- wmii fork with XCB, multihead, vertical column, command mode
+* [musca](http://aerosuidae.net/musca.html) -- inspired by dwm, more complex layout, configurable with commands, EWMH support
+* [qtile](http://www.qtile.org/) -- pure python wm, used ideas from dwm
+* [scrotwm](http://www.peereboom.us/scrotwm/html/scrotwm.html) -- dwm clone with multihead, config file, restart.. support
+* [TAL/wm](http://talwm.sourceforge.net/) -- minimal tiled wm based on dwm (discontinued)
+* [teslawm](http://teslawm.org/) -- dwm fork with multihead, mouse, stdin commands support (was dwm-rfigura)
+* [xmonad](http://www.xmonad.org/) -- dwm clone in haskell
diff --git a/dwm.suckless.org/patches/index.md b/dwm.suckless.org/patches/index.md
deleted file mode 100644
index 83dea6e..0000000
--- a/dwm.suckless.org/patches/index.md
+++ /dev/null
_AT_@ -1,62 +0,0 @@
-Patches
-=======
-
-There are two types of patches: The ones that fit to your personal taste and
-the ones you think should be included in mainline dwm.
-
-For patches that should be included in mainline dwm see the
-[community](//suckless.org/community) page and the hackers_AT_ mailing list.
-
-
-You can use the following instructions to generate and apply patches posted on
-this wiki. On how to upload patches which fit your personal taste and you want
-to show the community, see the [wiki](//suckless.org/wiki) page on how to edit
-the pages you see here.
-
-diff generation
----------------
-For git users:
-
-    cd dwm-directory
-    git diff > dwm-X.Y-yourpatchname.diff
-
-For tarballs:
-
-    cd modified-dwm-directory/..
-    diff -up original-dwm-directory modified-dwm-directory > dwm-X.Y-yourpatchname.diff
-
-where `X.Y` is a dwm tag name or version number.
-
-patch application
------------------
-For git users, use `-3` to fix the conflict easily:
-
-    cd dwm-directory
-    git apply path/to/patch.diff
-
-For tarballs:
-
-    cd dwm-directory
-    patch -p1 < path/to/patch.diff
-
-
-related projects
-----------------
-* [awesome](http://awesome.naquadah.org/) -- dwm fork with XCB, EWMH, Lua script, Xft, D-Bus, multihead.. support
-* [awm](http://www.freaknet.org/alpt/src/alpt-wm/readme) -- (old) modified dwm with workspaces and /proc like interface
-* [bwm](http://lists.suckless.org/dwm/0708/3085.html) -- (old) modified dwm with extensive mouse support
-* [cons-wm](http://github.com/dharmatech/psilab/tree/master/cons-wm) -- minimalist wm in scheme (not tiled)
-* [bug.n](https://github.com/fuhsjr00/bug.n) -- dwm for Windows written in AutoHotkey
-* [dvtm](http://www.brain-dump.org/projects/dvtm/) -- virtual terminal manager (dwm on the console)
-* [dwm-gtx](http://s01.de/~gottox/index.cgi/proj_dwm) -- dwm branch with Xinerama support, pointer movement, different layout
-* [dwm-sprinkles](http://0mark.unserver.de/dwm-sprinkles/) -- dwm with colorfull bar, transparency, pre-configured pertag and more
-* [dwm-win32](http://www.brain-dump.org/projects/dwm-win32/) -- dwm ported to windows
-* [echinus](http://www.rootshell.be/~polachok/code/) -- dwm fork with EWMH, Xft support
-* [gemini](http://gemini.digitalmediaplanet.net) -- terminal manager
-* [i3](http://i3.zekjur.net/) -- wmii fork with XCB, multihead, vertical column, command mode
-* [musca](http://aerosuidae.net/musca.html) -- inspired by dwm, more complex layout, configurable with commands, EWMH support
-* [qtile](http://www.qtile.org/) -- pure python wm, used ideas from dwm
-* [scrotwm](http://www.peereboom.us/scrotwm/html/scrotwm.html) -- dwm clone with multihead, config file, restart.. support
-* [TAL/wm](http://talwm.sourceforge.net/) -- minimal tiled wm based on dwm (discontinued)
-* [teslawm](http://teslawm.org/) -- dwm fork with multihead, mouse, stdin commands support (was dwm-rfigura)
-* [xmonad](http://www.xmonad.org/) -- dwm clone in haskell
diff --git a/dwm.suckless.org/patches/index.md b/dwm.suckless.org/patches/index.md
new file mode 120000
index 0000000..d457f51
--- /dev/null
+++ b/dwm.suckless.org/patches/index.md
_AT_@ -0,0 +1 @@
+../../../suckless.org/hacking.md
\ No newline at end of file
diff --git a/st.suckless.org/patches/index.md b/st.suckless.org/patches/index.md
deleted file mode 100644
index c94f048..0000000
--- a/st.suckless.org/patches/index.md
+++ /dev/null
_AT_@ -1,4 +0,0 @@
-Patches
--------
-Much like the [dwm patches](http://dwm.suckless.org/patches/) but for st.
-
diff --git a/st.suckless.org/patches/index.md b/st.suckless.org/patches/index.md
new file mode 120000
index 0000000..d457f51
--- /dev/null
+++ b/st.suckless.org/patches/index.md
_AT_@ -0,0 +1 @@
+../../../suckless.org/hacking.md
\ No newline at end of file
diff --git a/suckless.org/hacking.md b/suckless.org/hacking.md
index 6171fc0..4b18906 100644
--- a/suckless.org/hacking.md
+++ b/suckless.org/hacking.md
_AT_@ -26,27 +26,59 @@ If you encounter freezes (no crash at all) of the program, you can debug as foll
 Send the output of that command to the mailing list along with the output of
 `program -v`! Thank you!
 
-
 Patches
 -------
+There are two types of patches: The ones that fit to your personal taste and
+the ones you think should be included in mainline.
+
+For patches that should be included in mainline see the
+[community](//suckless.org/community) page and the hackers_AT_ mailing list.
+
+You can use the following instructions to generate and apply patches posted on
+this wiki. On how to upload patches which fit your personal taste and you want
+to show the community, see the [wiki](//suckless.org/wiki) page on how to edit
+the pages you see here.
+
+patch filename format
+---------------------
+The expected format for patches is
+
+For git revisions:
+
+    toolname-patchname-YYYYMMDD-SHORTHASH.diff
+    dwm-allyourbase-20160617-3465bed.diff
+
+The YYYYMMDD date should correspond to the last time the patch has been modified.  
+The SHORTHASH here is the seven chars git commit short hash corresponding to the
+last commit of the tool on which the patch can be applied correctly and
+is working with.
+You can get it by taking the first seven chars of the full hash or for example:
+
+    git rev-parse --short <commit-id> (with commit-id: HEAD, commit hash, etc.)
+
+For release versions:
+
+    toolname-patchname-RELEASE.diff
+    dwm-allyourbase-6.1.diff
+
+The RELEASE should correspond to the tool release version, ie 6.1 for dwm-6.1.
 
 diff generation
 ---------------
 For git users:
 
     cd program-directory
-    git diff > program-X.Y-yourpatchname.diff
+    git diff > toolname-patchname-YYYYMMDD-SHORTHASH.diff
 
 For tarballs:
 
     cd modified-program-directory/..
-    diff -up original-program-directory modified-program-directory > program-X.Y-yourpatchname.diff
-
-where `X.Y` is a dwm tag name or version number.
+    diff -up original-program-directory modified-program-directory > \
+               toolname-patchname-RELEASE.diff
 
 patch program
 -------------
-For git users:
+For git users, use -3 to fix the conflict easily:
 
     cd program-directory
     git apply path/to/patch.diff
diff --git a/surf.suckless.org/patches/index.md b/surf.suckless.org/patches/index.md
deleted file mode 100644
index 45bf99c..0000000
--- a/surf.suckless.org/patches/index.md
+++ /dev/null
_AT_@ -1,30 +0,0 @@
-Patches
-=======
-
-diff generation
----------------
-For git users:
-
-    cd surf-directory
-    git diff > surf-X.Y-yourpatchname.diff
-
-For tarballs:
-
-    cd modified-surf-directory/..
-    diff -up original-surf-directory modified-surf-directory > surf-X.Y-yourpatchname.diff
-
-where `X.Y` is a surf tag name or version number.
-
-
-patch application
------------------
-For git users:
-
-    cd surf-directory
-    git apply path/to/patch.diff
-
-For tarballs:
-
-    cd surf-directory
-    patch -p1 < path/to/patch.diff
-
diff --git a/surf.suckless.org/patches/index.md b/surf.suckless.org/patches/index.md
new file mode 120000
index 0000000..d457f51
--- /dev/null
+++ b/surf.suckless.org/patches/index.md
_AT_@ -0,0 +1 @@
+../../../suckless.org/hacking.md
\ No newline at end of file
diff --git a/tools.suckless.org/dmenu/patches/index.md b/tools.suckless.org/dmenu/patches/index.md
deleted file mode 100644
index efa7efa..0000000
--- a/tools.suckless.org/dmenu/patches/index.md
+++ /dev/null
_AT_@ -1,29 +0,0 @@
-Patches
-=======
-
-diff generation
----------------
-For git users:
-
-    cd dmenu-directory
-    git diff > dmenu-X.Y-yourpatchname.diff
-
-For tarballs:
-
-    cd modified-dmenu-directory/..
-    diff -up original-dmenu-directory modified-dmenu-directory > dmenu-X.Y-yourpatchname.diff
-
-where `X.Y` is a dmenu tag name or version number.
-
-
-patch application
------------------
-For git users:
-
-    cd dmenu-directory
-    git apply path/to/patch.diff
-
-For tarballs:
-
-    cd dmenu-directory
-    patch -p1 < path/to/patch.diff
diff --git a/tools.suckless.org/dmenu/patches/index.md b/tools.suckless.org/dmenu/patches/index.md
new file mode 120000
index 0000000..d457f51
--- /dev/null
+++ b/tools.suckless.org/dmenu/patches/index.md
_AT_@ -0,0 +1 @@
+../../../suckless.org/hacking.md
\ No newline at end of file
diff --git a/tools.suckless.org/ii/patches/index.md b/tools.suckless.org/ii/patches/index.md
deleted file mode 100644
index 7e09a92..0000000
--- a/tools.suckless.org/ii/patches/index.md
+++ /dev/null
_AT_@ -1,29 +0,0 @@
-Patches
-=======
-
-diff generation
----------------
-For git users:
-
-    cd ii-directory
-    git diff > ii-X.Y-yourpatchname.diff
-
-For tarballs:
-
-    cd modified-ii-directory/..
-    diff -up original-ii-directory modified-ii-directory > ii-X.Y-yourpatchname.diff
-
-where `X.Y` is an ii tag name or version number.
-
-
-patch application
------------------
-For git users:
-
-    cd ii-directory
-    git apply path/to/patch.diff
-
-For tarballs:
-
-    cd ii-directory
-    patch -p1 < path/to/patch.diff
diff --git a/tools.suckless.org/ii/patches/index.md b/tools.suckless.org/ii/patches/index.md
new file mode 120000
index 0000000..d457f51
--- /dev/null
+++ b/tools.suckless.org/ii/patches/index.md
_AT_@ -0,0 +1 @@
+../../../suckless.org/hacking.md
\ No newline at end of file
diff --git a/tools.suckless.org/sent/patches/index.md b/tools.suckless.org/sent/patches/index.md
deleted file mode 100644
index d4d86e8..0000000
--- a/tools.suckless.org/sent/patches/index.md
+++ /dev/null
_AT_@ -1,29 +0,0 @@
-Patches
-=======
-
-diff generation
----------------
-For git users:
-
-    cd sent-directory
-    git diff > sent-X.Y-yourpatchname.diff
-
-For tarballs:
-
-    cd modified-sent-directory/..
-    diff -up original-sent-directory modified-sent-directory > sent-X.Y-yourpatchname.diff
-
-where `X.Y` is a sent tag name or version number.
-
-
-patch application
------------------
-For git users:
-
-    cd sent-directory
-    git apply path/to/patch.diff
-
-For tarballs:
-
-    cd sent-directory
-    patch -p1 < path/to/patch.diff
diff --git a/tools.suckless.org/sent/patches/index.md b/tools.suckless.org/sent/patches/index.md
new file mode 120000
index 0000000..d457f51
--- /dev/null
+++ b/tools.suckless.org/sent/patches/index.md
_AT_@ -0,0 +1 @@
+../../../suckless.org/hacking.md
\ No newline at end of file
diff --git a/tools.suckless.org/sic/patches/index.md b/tools.suckless.org/sic/patches/index.md
deleted file mode 100644
index 77a57ae..0000000
--- a/tools.suckless.org/sic/patches/index.md
+++ /dev/null
_AT_@ -1,29 +0,0 @@
-Patches
-=======
-
-diff generation
----------------
-For git users:
-
-    cd sic-directory
-    git diff > sic-X.Y-yourpatchname.diff
-
-For tarballs:
-
-    cd modified-sic-directory/..
-    diff -up original-sic-directory modified-sic-directory > sic-X.Y-yourpatchname.diff
-
-where `X.Y` is an sic tag name or version number.
-
-
-patch application
------------------
-For git users:
-
-    cd sic-directory
-    git apply path/to/patch.diff
-
-For tarballs:
-
-    cd sic-directory
-    patch -p1 < path/to/patch.diff
diff --git a/tools.suckless.org/sic/patches/index.md b/tools.suckless.org/sic/patches/index.md
new file mode 120000
index 0000000..d457f51
--- /dev/null
+++ b/tools.suckless.org/sic/patches/index.md
_AT_@ -0,0 +1 @@
+../../../suckless.org/hacking.md
\ No newline at end of file
diff --git a/tools.suckless.org/slock/patches/index.md b/tools.suckless.org/slock/patches/index.md
deleted file mode 100644
index 8f85dce..0000000
--- a/tools.suckless.org/slock/patches/index.md
+++ /dev/null
_AT_@ -1,29 +0,0 @@
-Patches
-=======
-
-diff generation
----------------
-For git users:
-
-    cd slock-directory
-    git diff > slock-X.Y-yourpatchname.diff
-
-For tarballs:
-
-    cd modified-slock-directory/..
-    diff -up original-slock-directory modified-slock-directory > slock-X.Y-yourpatchname.diff
-
-where `X.Y` is a slock tag name or version number.
-
-
-patch application
------------------
-For git users:
-
-    cd slock-directory
-    git apply path/to/patch.diff
-
-For tarballs:
-
-    cd slock-directory
-    patch -p1 < path/to/patch.diff
diff --git a/tools.suckless.org/slock/patches/index.md b/tools.suckless.org/slock/patches/index.md
new file mode 120000
index 0000000..d457f51
--- /dev/null
+++ b/tools.suckless.org/slock/patches/index.md
_AT_@ -0,0 +1 @@
+../../../suckless.org/hacking.md
\ No newline at end of file
diff --git a/tools.suckless.org/tabbed/patches/index.md b/tools.suckless.org/tabbed/patches/index.md
deleted file mode 100644
index 5232c9d..0000000
--- a/tools.suckless.org/tabbed/patches/index.md
+++ /dev/null
_AT_@ -1,30 +0,0 @@
-Patches
-=======
-
-diff generation
----------------
-For git users:
-
-    cd tabbed-directory
-    git diff > tabbed-X.Y-yourpatchname.diff
-
-For tarballs:
-
-    cd modified-tabbed-directory/..
-    diff -up original-tabbed-directory modified-tabbed-directory > tabbed-X.Y-yourpatchname.diff
-
-where `X.Y` is a tabbed tag name or version number.
-
-
-patch application
------------------
-For git users:
-
-    cd tabbed-directory
-    git apply path/to/patch.diff
-
-For tarballs:
-
-    cd tabbed-directory
-    patch -p1 < path/to/patch.diff
-
diff --git a/tools.suckless.org/tabbed/patches/index.md b/tools.suckless.org/tabbed/patches/index.md
new file mode 120000
index 0000000..d457f51
--- /dev/null
+++ b/tools.suckless.org/tabbed/patches/index.md
_AT_@ -0,0 +1 @@
+../../../suckless.org/hacking.md
\ No newline at end of file
-- 
2.8.3
Received on Fri Jun 17 2016 - 13:20:33 CEST

This archive was generated by hypermail 2.3.0 : Fri Jun 17 2016 - 13:24:17 CEST