Wifi-menu: Multi-interface support and man page. by tetrakist · Pull Request #178 · joukewitteveen/netctl

tetrakist · 2020-05-19T08:55:56Z

This adds support for multiple interfaces to wifi-menu. It detects multiple wireless interfaces and presents the user with a menu, allowing them to choose which one to use. It also adds a man page for wifi-menu

joukewitteveen

Thanks for taking the time to improve netctl! The proposed changes are welcome, yet they need some tweaks before they can go in. Let's first look at the wifi-menu code.

joukewitteveen

Thanks for your quick response and apologies for being quite a bit slower ;-).

There's a lot of comments this time, but don't get me wrong: I am very happy with your contribution. Criticizing is just so much easier than writing.

Better phrasing on --help option description. Co-authored-by: Jouke Witteveen <j.witteveen@gmail.com>

Co-authored-by: Jouke Witteveen <j.witteveen@gmail.com>

joukewitteveen

A few minor nitpicks left. If you agree with them, please accept them and squash this PR to one or two (first with the changes to wifi-menu, second with the man-page) commits. After that we're done!

Thanks a lot!

joukewitteveen · 2020-06-01T09:17:04Z

+*wifi-menu* allows a user to interactively connect to a wireless network
+over INTERFACE using an existing netctl profile, or an automatically
+generated profile for basic configurations. If only one wireless
+interface is available, INTERFACE can be omitted.  If no interface is


Suggested change

interface is available, INTERFACE can be omitted. If no interface is

interface is available, INTERFACE can be omitted. If no interface is

(for consistency)

joukewitteveen · 2020-06-01T09:20:52Z

+over INTERFACE using an existing netctl profile, or an automatically
+generated profile for basic configurations. If only one wireless


The fact that only basic configurations are supported for generating profiles is already stressed in the next paragraph. No need to state it twice.

Suggested change

over INTERFACE using an existing netctl profile, or an automatically

generated profile for basic configurations. If only one wireless

on INTERFACE using a netctl profile. In case no netctl profile is available, one can be generated.

If only one wireless

(pending reflow to the proper number of columns)

joukewitteveen · 2020-06-01T09:21:55Z

+
+*wifi-menu* is only able to generate netctl profiles for simple network
+configurations. Profiles for more complex configurations must be set up
+manually, or through the use of other tools.


Suggested change

manually, or through the use of other tools.

manually.

This man-page is about wifi-menu, so we assume the intent is to use netctl.

joukewitteveen · 2020-06-01T09:34:25Z

+-----
+The program may display a black screen for up to a minute when starting a
+connection.
+


I'm not sure how best to word a statement about control by netctl-auto and switching profiles, so I will leave that for you to do as you see fit.

Maybe here? I'd appreciate your comments. Rather than me just adding a commit on top of yours, I think it is nice to make this part of your commit.

Suggested change

Starting a connection on an interface that is controlled by *netctl-auto* will

cause *wifi-menu* to switch to the selected network. The interface will continue

to be controlled by *netctl-auto*.

joukewitteveen · 2020-06-01T09:38:16Z

+    Do not echo password, and store derived pre-shared key
+    in profile instead of plaintext password.


I'm fine with "do not echo password". The "Show asterisks..." bit is just cut-and-paste from the output of --help. ;)

Ah, thanks for this remark! That reminds me of why I chose this wording. The 'do not echo' wording applies more to what you see for instance when you type your password on a login terminal (i.e. nothing at all).
Let's revert to something that closely resembles your original idea.

Suggested change

Do not echo password, and store derived pre-shared key

in profile instead of plaintext password.

Show asterisks for the characters of the password and store the password

as a hexadecimal pre-shared key.

joukewitteveen · 2020-06-01T09:40:35Z

+The program may display a black screen for up to a minute when starting a
+connection.


I believe this one got lost somewhere. If you disagree with my preference to make 'minute' refer less to a specific unit of time, I'd like to hear why.

Suggested change

The program may display a black screen for up to a minute when starting a

connection.

Establishing a connection may take a minute. While establishing a connection,

nothing is shown on screen.

joukewitteveen · 2020-06-01T09:41:50Z

+FILES
+-----
+/etc/netctl+::
+    Directory where created netctl profiles are stored.


This one got lost too. Here, 'generated' is more specific than 'created' and 'netctl' is implied.

Suggested change

Directory where created netctl profiles are stored.

Directory where generated profiles are stored.

joukewitteveen · 2020-06-01T09:42:59Z

+  -o, --obscure  Do not echo password, and store derived pre-shared
+                 key in profile instead of plaintext password.


Sorry about this ;-).

Suggested change

-o, --obscure Do not echo password, and store derived pre-shared

key in profile instead of plaintext password.

-o, --obscure Show asterisks for the characters of the password

and store the password as a hexadecimal string

joukewitteveen · 2020-06-26T10:19:51Z

Please let me know if you accept the final proposed changes. If you want me to, I can squash the commits for you.

joukewitteveen · 2020-10-09T12:03:18Z

I took the least intrusive part of this MR: 1e08e03.
If you want the interface selection dialog bits (which I am not against), please rebase on (or restart from) master. That way, we can get attribution right. Thanks!

tetrakist and others added 4 commits May 19, 2020 08:52

Create asciidoc for wifi-menu man page.

d6424e2

Add support for multiple interfaces.

eebfa4c

Renamed asciidoc file and corrected errors.

a7b4fed

Add renamed wifi-menu ascii doc file.

4286f3f

joukewitteveen requested changes May 21, 2020

View reviewed changes

Comment thread docs/wifi-menu.8.txt Outdated

Comment thread docs/wifi-menu.8.txt Outdated

Comment thread src/wifi-menu

Clean up code for wireless interface selection

5cb834a

joukewitteveen requested changes May 25, 2020

View reviewed changes

tetrakist and others added 7 commits May 26, 2020 17:39

Update docs/wifi-menu.8.txt

50b2b4b

Better phrasing on --help option description. Co-authored-by: Jouke Witteveen <j.witteveen@gmail.com>

better formatting in docs/wifi-menu.8.txt

a300cae

Co-authored-by: Jouke Witteveen <j.witteveen@gmail.com>

Better phrasing for file location in docs/wifi-menu.8.txt

8a52db6

Co-authored-by: Jouke Witteveen <j.witteveen@gmail.com>

Simplify interface option description in docs/wifi-menu.8.txt

cada564

Co-authored-by: Jouke Witteveen <j.witteveen@gmail.com>

Eliminate unneeded See-Alsos from docs/wifi-menu.8.txt

acf1c31

Co-authored-by: Jouke Witteveen <j.witteveen@gmail.com>

Maintain interface dimensions in src/wifi-menu

19e32dc

Co-authored-by: Jouke Witteveen <j.witteveen@gmail.com>

Better wording about connecting in docs/wifi-menu.8.txt

7964888

Co-authored-by: Jouke Witteveen <j.witteveen@gmail.com>

tetrakist force-pushed the multi-interface-support branch from c46add5 to 7964888 Compare May 26, 2020 18:59

tetrakist added 3 commits May 26, 2020 12:09

Improved --obscure description

1aca5aa

Remove Bugs section and simplify Description in wifi-menu.8.txt

7e39099

Update phrasing for NOTES and FILES sections in wifi-menu.8.txt

ab52366

joukewitteveen requested changes Jun 1, 2020

View reviewed changes

joukewitteveen added the no response label Jul 23, 2020

	interface is available, INTERFACE can be omitted. If no interface is
	interface is available, INTERFACE can be omitted. If no interface is

		over INTERFACE using an existing netctl profile, or an automatically
		generated profile for basic configurations. If only one wireless

+Starting a connection on an interface that is controlled by *netctl-auto* will
+cause *wifi-menu* to switch to the selected network. The interface will continue
+to be controlled by *netctl-auto*.

		Do not echo password, and store derived pre-shared key
		in profile instead of plaintext password.

		The program may display a black screen for up to a minute when starting a
		connection.

	Directory where created netctl profiles are stored.
	Directory where generated profiles are stored.

		-o, --obscure Do not echo password, and store derived pre-shared
		key in profile instead of plaintext password.

Conversation

tetrakist commented May 19, 2020

Uh oh!

joukewitteveen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joukewitteveen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joukewitteveen left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joukewitteveen commented Jun 26, 2020

Uh oh!

joukewitteveen commented Oct 9, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

joukewitteveen left a comment •

edited

Loading