Author: Erik Letson <email@example.com>
Date: Thu, 20 Aug 2020 15:20:25 -0500
explained nodoc in README
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/README b/README
@@ -35,7 +35,7 @@ guaranteed at this time. If any specific patches are known to be incompatible wi
patches' USAGE files. Normally, this should serve to document most incompatiblities, but in the case of the user applying a great many
patches all at once, it is possible that novel conflicts may occur. Be aware of this should you try to emerge with a huge number of
== Target Patches ==
suckless-gf-dmenu targets the patches located at the following locations:
@@ -53,6 +53,17 @@ patches!
NOTE THAT UNSUPPORTED PATCHES SHOULD BE SUPPORTED IN THE FUTURE!!!
+== NoDoc Patches ==
+ Among the most common causes of conflict between different dmenu patches is documentation changes. A great many patches make changes
+to the file 'dmenu.1', which defines the dmenu man page, and/or to the 'usage()' function in 'dmenu.c'. Both of these changes are only ever
+made for documentation purposes, and do not affect the actual functionality added by any given patch. Because so many differenct patches
+make changes to these places, they will often conflict. These conflicts are trivial to resolve, but in the interest of making the patches
+in suckless-gf-dmenu more robust and "just-work-y", any patch that makes changes to either 'dwm.1' or 'usage()' in 'dwm.c' will have a
+second version available, called 'xyz-nodoc.patch' (where 'xyz' is the patch name), that removes any documentation changes. These 'nodoc'
+patches are functionally the same as their regular counterparts, but they should avoid common conflicts with other patches that also
+change the documentation.
== License ==
suckless-gf-dmenu is released under the MIT/X Consortium License, the same license that dmenu itself is under: