readme: add per-buildsystem subdirectory

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>

1 files changed, 38 insertions, 0 deletions

diff --git a/README b/README
index fc1e396..f4125c0 100644
--- a/README
+++ b/README
@@ -166,6 +166,44 @@ or the problem is really a local hack where no proper fix is available.
 Please try really, really hard to avoid this tag.
 
 
+Directory Structure and Workflow
+--------------------------------
+
+The directory structure uses the name of the package plus it's version
+number on the top level. The naming scheme follows the tarball
+extraction naming scheme, for example:
+
+	libusb-1.0.8/
+
+If the upstream tarball extracts only to a directory named after the
+package name, the version shall be added with a dash.
+
+FIXME rsc: this probably needs to be formalized more deeply
+
+Below the package directory, each involved build system may have it's
+own subdirectory, for example:
+
+	libusb-1.0.8/ptxdist/
+
+If the build system finds a subdirectory with it's name, it shall use
+the patches found there. If such a subdirectory does not exist, the
+package directory shall be used to look for patches.
+
+These rules allow the following workflow:
+
+- A build system creates a package directory with the name and version
+  of a package it has patches for.
+- The build system adds it's patches to a <buildsystem>/ directory and
+  adds it's Used-in: tags.
+- The patches can be discussed on the mailing lists and it is possible
+  to collect further Acked-by: tags.
+- If the patch series has evolved up to a point where more build systems
+  agree on the patches, the whole series can be moved upwards, to the
+  package directory.
+- Packages who are not participating in a series can just avoid their
+  Used-in: tags and use their <buildsystem>/ subdirectory.
+
+
 Open Issues
 -----------