Changes between Version 3 and Version 4 of SummerOfCode2014_interactive

Timestamp:

Jun 26, 2014, 7:34:04 PM (10 years ago)

Author:

shasha@…

Comment:

--

SummerOfCode2014_interactive

@@ -72 +72 @@
 
 
-=== Ambiguous activate ===
-Desc: When port activate command is run ambiguously, give a list of ports to the user to choose from.
-
-Message: A list of all the port versions/variants of the port name given.
-
-Question type: A single choice question having multiple options is what is required in this case. The user is asked to choose one of the options.
-
-Example-
-{{{
-$> port activate foobar
-The following variants of foobar exist:
-  foobar @0.0.1 +xzy
-  foobar @0.0.2 +xzy
-  foobar @0.1
-Type a number to select the variant to activate: 2
----> foobar @0.0.2 +xzy activated.
-$>
-}}}
-
 === Uninstall using -—follow-dependencies ===
 Desc: When a user uninstalls using the flag —-follow-dependencies, ask for confirmation.
@@ -111 +92 @@
 $>
 }}}
+
+
+=== Variant specific dependency (Low-priority) ===
+Desc: When installing a port that requires a dependency to have a certain variant, but this variant is not set. Ask the user if it should reinstall the dependency with that variant. This interaction is currently marked low priority.
+
+Message: A warning message explaining that reinstalling with a specific variant could break any already-installed dependents that relied on the previously-selected variants.
+
+Question type: A yes/no question is suitable here. The correct variant will be selected and installed automatically so no need to provide options. 
+
+Example-
+{{{
+$> port install foobar
+The package 'foobar +quartz' requires 'barfoo +quartz' but 'barfoo' is installed.
+Warning: Reinstalling with a specific variant could break any already-installed dependents that relied on the previously-selected variants.
+Do you wish to install barfoo +quartz? [Y/n]: Y
+---> Installing barfoo @1.0.1 +xzy
+——-> Installing foobar
+$>
+}}}
+
+=== Choose variants interactively (Low-priority) ===
+Desc: When installing a port the user can be given a list of all the variants of the port they wish to install and they can select them interactively. This interaction is currently flagged low priority.
+
+Message: A list of all the variants to choose from.
+
+Question type: A multiple choice question where the user can select the options they want. Then pressing enter proceeds with the install.
+
+Example-
+{{{
+$> port install foobar
+"foobar" has many variants. Which of the following variants do you want to install?
+  (1) foobar @0.0.1 +xzy
+  (2) foobar @0.0.2 +xzy
+  (3) foobar @0.0.3
+Enter a space separated string of choices to select the ports to uninstall: 1
+---> Installing foobar @0.0.1 +xzy
+$>
+}}}
+
+= Use Cases Completed =
 
 === Ambiguous uninstall ===
@@ -132 +153 @@
 }}}
 
-=== Variant specific dependency (Low-priority) ===
-Desc: When installing a port that requires a dependency to have a certain variant, but this variant is not set. Ask the user if it should reinstall the dependency with that variant. This interaction is currently marked low priority.
-
-Message: A warning message explaining that reinstalling with a specific variant could break any already-installed dependents that relied on the previously-selected variants.
-
-Question type: A yes/no question is suitable here. The correct variant will be selected and installed automatically so no need to provide options. 
-
-Example-
-{{{
-$> port install foobar
-The package 'foobar +quartz' requires 'barfoo +quartz' but 'barfoo' is installed.
-Warning: Reinstalling with a specific variant could break any already-installed dependents that relied on the previously-selected variants.
-Do you wish to install barfoo +quartz? [Y/n]: Y
----> Installing barfoo @1.0.1 +xzy
-——-> Installing foobar
-$>
-}}}
-
-=== Choose variants interactively (Low-priority) ===
-Desc: When installing a port the user can be given a list of all the variants of the port they wish to install and they can select them interactively. This interaction is currently flagged low priority.
-
-Message: A list of all the variants to choose from.
-
-Question type: A multiple choice question where the user can select the options they want. Then pressing enter proceeds with the install.
-
-Example-
-{{{
-$> port install foobar
-"foobar" has many variants. Which of the following variants do you want to install?
-  (1) foobar @0.0.1 +xzy
-  (2) foobar @0.0.2 +xzy
-  (3) foobar @0.0.3
-Enter a space separated string of choices to select the ports to uninstall: 1
----> Installing foobar @0.0.1 +xzy
-$>
-}}}
-
-= Use Cases Completed =
+
+=== Ambiguous activate ===
+Desc: When port activate command is run ambiguously, give a list of ports to the user to choose from.
+
+Message: A list of all the port versions/variants of the port name given.
+
+Question type: A single choice question having multiple options is what is required in this case. The user is asked to choose one of the options.
+
+Example-
+{{{
+$> port activate foobar
+The following variants of foobar exist:
+  foobar @0.0.1 +xzy
+  foobar @0.0.2 +xzy
+  foobar @0.1
+Type a number to select the variant to activate: 2
+---> foobar @0.0.2 +xzy activated.
+$>
+}}}
 
 === Rebuilding in rev-upgrade ===
@@ -219 +221 @@
 Under ui_ask_ namespace:
 
-ui_ask_yesorno: deals with all the continue/abort type questions
-
-ui_ask_onechoice: deals with all the single choice selection questions
-
-ui_ask_manychoice: deals with questions that offer many more than one selections
-
-ui_ask_timeout: deals with questions that may have better functionality with timeouts
-
-=== Parameters ===
-qid: This parameter is most important as it will enable the port client to identify the question and print the correct interactivity case.
-(Incomplete)
+ui_ask_yesno: deals with all the continue/abort type questions
+
+ui_ask_singlechoice: deals with all the single choice selection questions
+
+ui_ask_multichoice: deals with questions that offer many more than one selections
+
+ui_timeout: deals with yes/no questions that may have better functionality with timeouts
+