<pre style='margin:0'>
Joshua Root (jmroot) pushed a commit to branch master
in repository macports-guide.

</pre>
<p><a href="https://github.com/macports/macports-guide/commit/79a0ba21f3badfb6dcec81daec6adbc036899feb">https://github.com/macports/macports-guide/commit/79a0ba21f3badfb6dcec81daec6adbc036899feb</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 79a0ba2  guide: document 'port notes'
</span>79a0ba2 is described below

<span style='display:block; white-space:pre;color:#808000;'>commit 79a0ba21f3badfb6dcec81daec6adbc036899feb
</span>Author: Joshua Root <jmr@macports.org>
AuthorDate: Fri Dec 18 22:50:00 2020 +1100

<span style='display:block; white-space:pre;color:#404040;'>    guide: document 'port notes'
</span>---
 guide/adoc/using.adoc | 23 ++++++++++++++++++++++-
 guide/xml/using.xml   | 19 +++++++++++++++++++
 2 files changed, 41 insertions(+), 1 deletion(-)

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/using.adoc b/guide/adoc/using.adoc
</span><span style='display:block; white-space:pre;color:#808080;'>index 83f3967..b15e1bd 100644
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/using.adoc
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/using.adoc
</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -469,6 +469,27 @@ Pass this flag, if you want to avoid running this step, for example if you want
</span> By default, each port you install using the `+install+` explicitly (contrary to ports installed as a dependency of a different port) is marked as "`requested`".
 If you want MacPorts to treat a port you installed manually as if it was automatically installed as a dependency (e.g., if a dependency failed to build and you re-tried installing the dependency only), pass this flag.
 
<span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.notes]]
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+=== port notes
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+The `+notes+` action is used to display any notes that a port's author included. These can contain
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+anything, but by convention are brief, and typically contain quick start steps for configuring and
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+using the port, pitfalls to watch out for, or other information that users should be aware of.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+These same notes are also displayed after installing a port. Many ports have no notes. More
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+extensive documentation can often be found at a port's homepage, or in its installed files.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[source]
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+----
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+$ port notes xinit
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+----
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+----
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+--->  xinit has the following notes:
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+  To use MacPorts' X11 as the default server, install xorg-server, log out, and
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+  log back in.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+----
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span> [[using.port.clean]]
 === port clean
 
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1543,4 +1564,4 @@ All packages are placed in a port's work directory, which you can locate using:
</span> [source]
 ----
 $ port work portname
<span style='display:block; white-space:pre;background:#ffe0e0;'>-----
</span>\ No newline at end of file
<span style='display:block; white-space:pre;background:#e0ffe0;'>+----
</span><span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/xml/using.xml b/guide/xml/using.xml
</span><span style='display:block; white-space:pre;color:#808080;'>index 87e875c..ebf98d5 100644
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/xml/using.xml
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/xml/using.xml
</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -550,6 +550,25 @@ apache2 has the variants:
</span>             </variablelist>
         </section>
 
<span style='display:block; white-space:pre;background:#e0ffe0;'>+        <section xml:id="using.port.notes">
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+            <title>port notes</title>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+            <para>The <option>notes</option> action is used to display any notes that a port's author
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+            included. These can contain anything, but by convention are brief, and typically contain quick
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+            start steps for configuring and using the port, pitfalls to watch out for, or other
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+            information that users should be aware of. These same notes are also displayed after installing a port.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+            Many ports have no notes. More extensive documentation can often be found at a port's
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+            homepage, or in its installed files.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+            <programlisting><prompt>$ </prompt><userinput>port notes xinit</userinput></programlisting>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+            <screen>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+--->  xinit has the following notes:
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+  To use MacPorts' X11 as the default server, install xorg-server, log out, and
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+  log back in.</screen>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+        </section>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span>         <section xml:id="using.port.clean">
             <title>port clean</title>
 
</pre><pre style='margin:0'>

</pre>