diff mbox

[maintainer-tools] Add flowchart to help determine appropriate branch

Message ID 20170720141729.37941-1-seanpaul@chromium.org (mailing list archive)
State New, archived
Headers show

Commit Message

Sean Paul July 20, 2017, 2:17 p.m. UTC 
This patch adds a flowchart to the drm-misc documentation to
help committers decide which branch is most appropriate for a
given patch.

Signed-off-by: Sean Paul <seanpaul@chromium.org>
---
 .gitignore               |  1 +
 Makefile                 |  2 +-
 drm-misc-commit-flow.dot | 22 ++++++++++++++++++++++
 drm-misc.rst             | 10 ++++++++++
 4 files changed, 34 insertions(+), 1 deletion(-)
 create mode 100644 drm-misc-commit-flow.dot
diff mbox

Patch

diff --git a/.gitignore b/.gitignore
index e2bd6b6..35ed071 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@ 
 drm-intel-flow.svg
+drm-misc-commit-flow.svg
 *.html
 .*
 *~
diff --git a/Makefile b/Makefile
index e079e35..44fcdc9 100644
--- a/Makefile
+++ b/Makefile
@@ -18,7 +18,7 @@  drm-intel.html: drm-intel.rst drm-intel-flow.svg drm-intel-timeline.rst drm-inte
 	sed -i 's/<body/<body onload="WaveDrom.ProcessAll()"/' $@
 
 # the sed bit here is a hack to make wavedrom process the timeline
-drm-misc.html: drm-misc.rst drm-misc-timeline.rst drm-misc-timeline.json
+drm-misc.html: drm-misc.rst drm-misc-timeline.rst drm-misc-timeline.json drm-misc-commit-flow.svg
 	rst2html $< > $@
 	sed -i 's/<body/<body onload="WaveDrom.ProcessAll()"/' $@
 
diff --git a/drm-misc-commit-flow.dot b/drm-misc-commit-flow.dot
new file mode 100644
index 0000000..04afab6
--- /dev/null
+++ b/drm-misc-commit-flow.dot
@@ -0,0 +1,22 @@ 
+digraph {
+	next_0[shape=box, style=rounded, color=blue, label="drm-misc-next"];
+	next_1[shape=box, style=rounded, color=blue, label="drm-misc-next"];
+	fixes_0[shape=box, style=rounded, color=blue, label="drm-misc-fixes"];
+	next_fixes_0[shape=box, style=rounded, color=blue,
+		     label="drm-misc-next-fixes"];
+
+	is_fix[shape=diamond, color=red, label="Is this a bug fix?"];
+	in_origin[shape=diamond, color=red,
+		  label="Is the bug in the current rc?"];
+	is_late[shape=diamond, color=red,
+		label="Is drm in feature freeze?\n(occurs after -rc6)"];
+
+	is_fix -> next_0[label="no"];
+	is_fix -> in_origin[label="yes"];
+
+	in_origin -> fixes_0[label="yes"]
+	in_origin -> is_late[label="no"];
+
+	is_late -> next_1[label="no"]
+	is_late -> next_fixes_0[label="yes"]
+}
diff --git a/drm-misc.rst b/drm-misc.rst
index c66ac67..05ccefb 100644
--- a/drm-misc.rst
+++ b/drm-misc.rst
@@ -73,6 +73,16 @@  updated drm-tip gets rebuilt. If there's a conflict see section on `resolving
 conflicts when rebuilding drm-tip
 <drm-intel.html#resolving-conflicts-when-rebuilding-drm-tip>`_.
 
+Where Do I Apply My Patch?
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Consult this handy flowchart to determine the best branch for your patch. If in
+doubt, apply to drm-misc-next or ask your favorite maintainer on IRC.
+
+.. Note: This requires SVG support in the browser.
+.. raw:: html
+	:file: drm-misc-commit-flow.svg
+
 Merge Timeline
 ~~~~~~~~~~~~~~