<pre style='margin:0'>
Christopher Nielsen (mascguy) pushed a commit to branch master
in repository macports-guide.
</pre>
<p><a href="https://github.com/macports/macports-guide/commit/365dbf588b496b920eef67fbf6e0b7bf651a4f6e">https://github.com/macports/macports-guide/commit/365dbf588b496b920eef67fbf6e0b7bf651a4f6e</a></p>
<pre style="white-space: pre; background: #F8F8F8">The following commit(s) were added to refs/heads/master by this push:
<span style='display:block; white-space:pre;color:#404040;'> new 365dbf5 Describe GitHub changeset links in 7.1.3 Trac Ticket Guidelines
</span>365dbf5 is described below
<span style='display:block; white-space:pre;color:#808000;'>commit 365dbf588b496b920eef67fbf6e0b7bf651a4f6e
</span>Author: Jim DeLaHunt <from+project_by_git@jdlh.com>
AuthorDate: Fri Sep 25 19:40:29 2020 -0700
<span style='display:block; white-space:pre;color:#404040;'> Describe GitHub changeset links in 7.1.3 Trac Ticket Guidelines
</span><span style='display:block; white-space:pre;color:#404040;'>
</span><span style='display:block; white-space:pre;color:#404040;'> Describe the use of Trac changeset links, with a GitHub commit SHA
</span><span style='display:block; white-space:pre;color:#404040;'> and repository name, as the preferred way to link to a commit in
</span><span style='display:block; white-space:pre;color:#404040;'> the MacPorts repositories in GitHub.
</span><span style='display:block; white-space:pre;color:#404040;'>
</span><span style='display:block; white-space:pre;color:#404040;'> There is a one-sentence summary in the TL;DR section, followed by
</span><span style='display:block; white-space:pre;color:#404040;'> a one-paragraph explanation in the "Description" bullet item below.
</span><span style='display:block; white-space:pre;color:#404040;'> There is a link to TracLinks#LinkstoMacPortsonGitHub in the wiki
</span><span style='display:block; white-space:pre;color:#404040;'> for the full explanation.
</span><span style='display:block; white-space:pre;color:#404040;'>
</span><span style='display:block; white-space:pre;color:#404040;'> Also, break the "Description" bullet item into two sub-bullets,
</span><span style='display:block; white-space:pre;color:#404040;'> because there is a bit too much to read comfortably in one paragraph.
</span><span style='display:block; white-space:pre;color:#404040;'>
</span><span style='display:block; white-space:pre;color:#404040;'> Change applied to the DocBook sources in guide/xml/project.xml, and
</span><span style='display:block; white-space:pre;color:#404040;'> corresponding change applied to the adoc sources in
</span><span style='display:block; white-space:pre;color:#404040;'> guide/adoc/project.adoc.
</span>---
guide/adoc/project.adoc | 21 +++++++++++++++++----
guide/xml/project.xml | 28 +++++++++++++++++++++++-----
2 files changed, 40 insertions(+), 9 deletions(-)
<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/project.adoc b/guide/adoc/project.adoc
</span><span style='display:block; white-space:pre;color:#808080;'>index 05b0e2d..4df4b7a 100644
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/project.adoc
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/project.adoc
</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -87,8 +87,10 @@ Please see below for longer and more detailed explanations.
</span> Describe your problem. Preformatted text (such as terminal
output) should be put in ``+{{{``+three curly
brackets+``}}}+``. Please attach large
<span style='display:block; white-space:pre;background:#ffe0e0;'>- amounts of output rather than pasting. Use the preview
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- button!
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ amounts of output rather than pasting.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Link to GitHub commits with links like
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ ``[changeset:``bd5d680…``/macports-ports`` commit bd5d680``]``.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Use the preview button!
</span>
|**Type**
|
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -182,8 +184,19 @@ There are certain conventions used to ensure that Trac tickets convey as much ac
</span>
* *Summary:*``+[port]+````+[version]+````+[concise description]+``
** Example: "rrdtool @1.2.23 +python Configure error - build failure"
<span style='display:block; white-space:pre;background:#ffe0e0;'>-* *Description:* All details that might be relevant to someone reading the ticket. Be sure to mention the versions of your operating system and Xcode install. https://trac.macports.org/wiki/WikiFormatting[Wiki formatting] should be used to ensure that text is formatted correctly. Use the Preview button before submitting. If you want to post preformatted text such as a log or terminal output, make sure you use `+{{{``+$$...$$+``}}}+` around the text or it could break the page layout. Example:
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* *Description:* All details that might be relevant to someone reading the ticket. Be sure to mention the versions of your operating system and Xcode install.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+** Use https://trac.macports.org/wiki/WikiFormatting[Wiki formatting] to ensure that text is formatted correctly.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Link to GitHub commits with ``[changeset:``GithubSHA``/macports-ports``
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+optional link text``]``.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+For example, for a GitHub commit with URL
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+https://github.com/macports/macports-ports/commit/bd5d6800828a3dcda1b65f3999fa748a365b168e,
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+put ``[changeset:bd5d6800828a3dcda1b65f3999fa748a365b168e/macports-ports
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+commit bd5d680]`` in the description. It becomes the link,
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+https://trac.macports.org/changeset/bd5d6800828a3dcda1b65f3999fa748a365b168e/macports-ports[commit bd5d680]. See
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+https://trac.macports.org/wiki/TracLinks#LinkstoMacPortsonGitHub[TracLinks#LinkstoMacPortsonGitHub] for details.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>++
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+** Use the Preview button before submitting. If you want to post preformatted text such as a log or terminal output, make sure you use `+{{{``+$$...$$+``}}}+` around the text or it could break the page layout. Example:
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>++
</span> ....
{{{
<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/xml/project.xml b/guide/xml/project.xml
</span><span style='display:block; white-space:pre;color:#808080;'>index 0b0faef..4759ea0 100644
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/xml/project.xml
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/xml/project.xml
</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -144,8 +144,11 @@
</span> Describe your problem. Preformatted text (such as terminal
output) should be put in <literal>{{{<replaceable>three curly
brackets</replaceable>}}}</literal>. Please attach large
<span style='display:block; white-space:pre;background:#ffe0e0;'>- amounts of output rather than pasting. Use the preview
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- button!
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ amounts of output rather than pasting.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Link to GitHub commits with links like
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <literal>[changeset:<replaceable>bd5d680…</replaceable>/macports-ports
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <replaceable>commit bd5d680</replaceable>]</literal>.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Use the preview button!
</span> </entry>
</row>
<row>
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -277,10 +280,25 @@
</span> <listitem>
<para><emphasis role="strong">Description:</emphasis> All details that might
be relevant to someone reading the ticket. Be sure to mention
<span style='display:block; white-space:pre;background:#ffe0e0;'>- the versions of your operating system and Xcode install. <link
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ the versions of your operating system and Xcode install. </para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Use <link
</span> xlink:href="https://trac.macports.org/wiki/WikiFormatting">Wiki
<span style='display:block; white-space:pre;background:#ffe0e0;'>- formatting</link> should be used to ensure that text is formatted
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- correctly. Use the Preview button before submitting. If you want to
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ formatting</link> to ensure that text is formatted correctly.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Link to GitHub commits with
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <literal>[changeset:<replaceable>GithubSHA</replaceable>/macports-ports
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <replaceable>optional link text</replaceable>]</literal>.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ For example, for a GitHub commit with URL
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <link xlink:href="https://github.com/macports/macports-ports/commit/bd5d6800828a3dcda1b65f3999fa748a365b168e">
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ https://github.com/macports/macports-ports/commit/bd5d6800828a3dcda1b65f3999fa748a365b168e</link>,
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ put <literal>[changeset:bd5d6800828a3dcda1b65f3999fa748a365b168e/macports-ports
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ commit bd5d680]</literal> in the description. It becomes the link,
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <link xlink:href="https://trac.macports.org/changeset/bd5d6800828a3dcda1b65f3999fa748a365b168e/macports-ports">
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ commit bd5d680</link>. See <link
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ xlink:href="https://trac.macports.org/wiki/TracLinks#LinkstoMacPortsonGitHub">
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ TracLinks#LinkstoMacPortsonGitHub</link> for details.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>Use the Preview button before submitting. If you want to
</span> post preformatted text such as a log or terminal output, make sure
you use <literal>{{{<replaceable>...</replaceable>}}}</literal>
around the text or it could break the page layout. Example:</para>
</pre><pre style='margin:0'>
</pre>