Opened 5 years ago

Closed 5 years ago

#50023 closed enhancement (fixed)

Clarification of variant specifiers in section 3.1.10 of guide

Reported by: alexreg@… Owned by: markd@…
Priority: Normal Milestone:
Component: guide Version:
Keywords: Cc: raimue (Rainer Müller)
Port:

Description

The following patch clarifies a paragraph describing the output of the port variants command.

456,457c456,458
<                 with other variants, a line with the details on that follows. Variant lines that have a
<                 <option>+</option> are enabled and those with <option>-</option> are disabled.
---
>                 with other variants, a line detailing that follows. Variant lines that have a <option>+</option> are
> 				enabled by default; such variants can be explicitly disabled on the command line by prefixing their
> 				names with <option>-</option>.

Change History (6)

comment:1 in reply to:  description Changed 5 years ago by alexreg@…

Sorry, forgot to say that the file to be patched is /trunk/doc-new/guide/xml/using.xml.

Replying to alexreg@…:

The following patch clarifies a paragraph describing the output of the port variants command.

456,457c456,458
<                 with other variants, a line with the details on that follows. Variant lines that have a
<                 <option>+</option> are enabled and those with <option>-</option> are disabled.
---
>                 with other variants, a line detailing that follows. Variant lines that have a <option>+</option> are
> 				enabled by default; such variants can be explicitly disabled on the command line by prefixing their
> 				names with <option>-</option>.

comment:2 Changed 5 years ago by neverpanic (Clemens Lang)

That change removes the explanation of negative variant output, e.g. in port variants nginx -spdy. Please restore it.

Additionally, we prefer unified patches, since they are easier to review and apply when the file has changed meanwhile. Additionally, the using.xml file uses spaces for indentation, please keep it that way.

comment:3 Changed 5 years ago by raimue (Rainer Müller)

Cc: raimue@… added

Cc Me!

comment:4 Changed 5 years ago by alexreg@…

Here's a better update, which clarifies that variants can in fact be passed to the variants command itself, and that bracketed + means the variant is default.

--- using.orig.xml	2015-12-14 16:27:51.000000000 +0000
+++ using.xml	2015-12-15 17:15:09.000000000 +0000
@@ -439,7 +439,7 @@
                 your build at install time. See <link linkend="using.variants.invoking">Invoking Port Variants</link>
                 below to install ports that have variants.</para>
 
-            <programlisting><prompt>$ </prompt><userinput>port variants apache2</userinput></programlisting>
+            <programlisting><prompt>$ </prompt><userinput>port variants apache2 +universal</userinput></programlisting>
 
             <screen>
 apache2 has the variants:
@@ -448,13 +448,15 @@
    openldap: Enable LDAP support through OpenLDAP
 [+]preforkmpm: Use prefork MPM
      * conflicts with eventmpm workermpm
-   universal: Build for multiple architectures
+  +universal: Build for multiple architectures
    workermpm: Use worker MPM
      * conflicts with eventmpm preforkmpm</screen>
 
             <para>This output lists all variants followed by their description. If a variant depends on or conflicts
-                with other variants, a line with the details on that follows. Variant lines that have a
-                <option>+</option> are enabled and those with <option>-</option> are disabled.
+                with other variants, a line detailing that follows. A variant name prefixed by <option>+</option>
+                indicates that it has been enabled (on the command line), while a prefix <option>-</option> indicates
+                that it has been disabled. When bracketed, a prefix <option>+</option> means that the variant is enabled
+                by default.
                 Any <option>[]</option> are derived from the <filename>Portfile</filename>.
                 While <option>()</option> are derived from the <filename>variants.conf</filename>.
                 See <xref

I hope that looks good to you as well.

comment:5 Changed 5 years ago by mf2k (Frank Schima)

Type: submissionenhancement
Version: 2.3.4

FYI, a "submission" ticket type is only for a new port submission.

comment:6 Changed 5 years ago by neverpanic (Clemens Lang)

Resolution: fixed
Status: newclosed

Thank you: r143651.

Note: See TracTickets for help on using tickets.