Skip to content

Commit 82c70e0

Browse files
Differentiate between GNU getopt and gnu-getopt brew formula
This commit will clearly differentiate between GNU getopt the tool and gnu-getopt the Homebrew formula. Also updating the URL so that getopt points at the source repository and pyenv and pyenv-virtualenv point at their respective repositories. Updated the ending punctuation. Co-authored-by: Nick <[email protected]>
1 parent e5a2d14 commit 82c70e0

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,10 @@ project.
4949
The `setup-env` tool in this repository is our recommended method
5050
for automating the entire environment configuration process. The
5151
dependencies required to run this tool are
52-
[`gnu-getopt`](https://manned.org/getopt.1), `pyenv`, and
53-
`pyenv-virtualenv`. If these tools are already configured on
54-
your system, you can simply run the following command.
52+
[GNU `getopt`](https://github.com/util-linux/util-linux/blob/master/misc-utils/getopt.1.adoc),
53+
[`pyenv`](https://github.com/pyenv/pyenv), and [`pyenv-virtualenv`](https://github.com/pyenv/pyenv-virtualenv).
54+
If these tools are already configured on your system, you can simply run the
55+
following command:
5556

5657
```console
5758
./setup-env
@@ -60,7 +61,7 @@ your system, you can simply run the following command.
6061
Otherwise, follow the steps below to manually configure your
6162
environment.
6263

63-
#### Installing and using `gnu-getopt`, `pyenv`, and `pyenv-virtualenv` ####
64+
#### Installing and using GNU `getopt`, `pyenv`, and `pyenv-virtualenv` ####
6465

6566
On the Mac, we recommend installing [brew](https://brew.sh/). Then
6667
installation is as simple as `brew install gnu-getopt pyenv pyenv-virtualenv` and
@@ -81,8 +82,8 @@ install the necessary tools. Before running this ensure that you have
8182
installed the prerequisites for your platform according to the
8283
[`pyenv` wiki
8384
page](https://github.com/pyenv/pyenv/wiki/common-build-problems).
84-
`gnu-getopt` is generally included in the core utilities of most
85-
Linux distributions.
85+
GNU `getopt` is included in most Linux distributions as part of the
86+
[`util-linux`](https://github.com/util-linux/util-linux) package.
8687

8788
On WSL you should treat your platform as whatever Linux distribution
8889
you've chosen to install.

setup-env

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ SHORTOPTS="fhiln:v:"
5858
if [[ $(getopt --version 2> /dev/null) != *"getopt from util-linux"* ]]; then
5959
cat << 'END_OF_LINE'
6060
61-
Gnu-getopt is not detected and is a dependency to run this script.
61+
GNU getopt is not detected and is a dependency to run this script.
6262
On the Mac, we recommend installing brew, https://brew.sh/. Then installation
6363
is as simple as `brew install gnu-getopt` and adding this to your
6464
profile:

0 commit comments

Comments
 (0)