Hi, is this ok to push? I gathered the information myself by experimenting with the GCC Bugzilla and reading the Bugzilla documentation page I link to in the patch. Html validated with validator.w3.org.
Thanks, Filip Kastl --- htdocs/bugs/management.html | 45 +++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/htdocs/bugs/management.html b/htdocs/bugs/management.html index b2bb740e..cc72271c 100644 --- a/htdocs/bugs/management.html +++ b/htdocs/bugs/management.html @@ -249,5 +249,50 @@ encounter a PR that is marked as "resolved fixed", but should be marked as a duplicate, please change the resolution. (You have to reopen the PR before you can resolve it as a duplicate.)</p> +<h2>Bugzilla tips and tricks</h2> + +<h3>Automatic linking</h3> + +<p>When writing a description of a new bug or commenting on an already existing +bug, you can make use of certain shortcuts to link to other bugs, commits, +comments and similar stuff. Here is a (most likely incomplete) list of these +shortcuts:</p> + +<h4>Bugs, comments and attachments</h4> +<ul> + <li>A string <code>pr XXXX</code> or <code>bug XXXX</code> where + <code>XXXX</code> is a Bugzilla bug ID automatically gets turned into a + link to the appropriate bug page.</li> + <li><code>attachment X</code> will link to the attachment with ID + <code>X</code>.</li> + <li><code>comment X</code> gets turned into a link to the <code>X</code>-th + comment under <i>this</i> bug.</li> + <li>You can use <code>bug XXXX, comment Y</code> to link to a comment + under a different bug. Using <code>pr</code> doesn't work here.</li> +</ul> +These shortcut keywords are case-insensitive. Except for the +<code>pr</code> keyword, these are actually not specific to GCC Bugzilla. +See <a +href=https://bugzilla.readthedocs.io/en/latest/using/tips.html#autolinkification> +Bugzilla documentation</a>. + +<h4>Commits</h4> +<ul> + <li><code>g:XXXXXXX</code> where <code>XXXXXXX</code> is a prefix of the + hash of a commit links to + <code>https://gcc.gnu.org/cgit/gcc/commit/?id=XXXXXXX</code>. The + prefix must be at least 7 characters long.</li> + <li><code>rXX-YYYY</code> links to + <code>https://gcc.gnu.org/cgi-bin/gcc-gitref.cgi?r=rXX-YYYY</code>. So + this way you can link to the <code>YYYY</code>-th commit of GCC version + <code>XX</code>.</li> + <li>Combining the two variants is also possible: + <code>rXX-YYYY-gZZZZZZZ</code> will link to + <code>https://gcc.gnu.org/cgit/gcc/commit/?id=ZZZZZZZ</code>. So the + <code>gZZZZZZZ</code> takes precedence. Btw, you can use the script + <code>contrib/git-descr.sh</code> from the GCC's source tree to convert + commit hashes to this format.</li> +</ul> + </body> </html> -- 2.51.0
