[PATCH docs] Fix incorrect autodelegation documentation

vkabatov at redhat.com vkabatov at redhat.com
Wed Apr 4 02:18:36 AEST 2018


From: Veronika Kabatova <vkabatov at redhat.com>

The docs suggested to account for git prefixes (a/, b/) using eg.
?/patchwork/views/*. My rules didn't work so I tried bare path
(patchwork/views/*) instead. Looking at the code, the prefix really is
striped away (filename = '/'.join(filename.split('/')[1:])). Fix the
documentation to reflect on what is really happening.

Signed-off-by: Veronika Kabatova <vkabatov at redhat.com>
---
 docs/usage/delegation.rst | 15 +++++----------
 1 file changed, 5 insertions(+), 10 deletions(-)

diff --git a/docs/usage/delegation.rst b/docs/usage/delegation.rst
index eaabc20..8b99871 100644
--- a/docs/usage/delegation.rst
+++ b/docs/usage/delegation.rst
@@ -30,21 +30,16 @@ Path
 
   A path in `fnmatch`__ format. The fnmatch library allows for limited, Unix
   shell-style wildcarding. Filenames are extracted from patch lines beginning
-  with ``---`` or ``+++``. Note that for projects using Git or Mercurial, the
-  tools these VCS provide for producing patches are prefixed with `a` or `b`.
-  You should account for this in your path. For example, to match the path
-  `patchwork/views` (relative to the top of a Git repo) your pattern should
-  be::
+  with ``---`` or ``+++``.
 
-      ?/patchwork/views/*
+  You can simply use a bare path::
 
-  It is also possible to use relative paths, such as::
+      patchwork/views/about.py
 
-      */manage.py
+  Or it is also possible to use relative paths, such as::
 
-  For projects using other VCSs like Subversion can simply use a bare path::
+      */manage.py
 
-      patchwork/views/*
 
 Rules are configured by setting the above fields and saving the rules. These
 rules will be applied at patch parse time.
-- 
2.13.6



More information about the Patchwork mailing list