Skip to content

Commit 161dbca

Browse files
DannyBenDannyBen
committed
- Add man documentation
1 parent 405bb31 commit 161dbca

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+2228
-30
lines changed

‎.github/workflows/test.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
runs-on: ubuntu-latest
1010
steps:
1111
- name: Checkout code
12-
uses: actions/checkout@v2
12+
uses: actions/checkout@v3
1313
- name: Run shellcheck tests
1414
run: shellcheck rush setup
1515
- name: Build container for approval tests
@@ -22,7 +22,7 @@ jobs:
2222
runs-on: ubuntu-latest
2323
steps:
2424
- name: Checkout code
25-
uses: actions/checkout@v2
25+
uses: actions/checkout@v3
2626
- name: Run setup
2727
run: ./setup
2828
- name: Test setup artifacts
@@ -33,7 +33,7 @@ jobs:
3333
runs-on: macos-latest
3434
steps:
3535
- name: Checkout code
36-
uses: actions/checkout@v2
36+
uses: actions/checkout@v3
3737
- name: Upgrade the outdated bash
3838
run: brew install bash
3939
- name: Run setup

‎doc/rush-add.1‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
.\" Automatically generated by Pandoc 3.1.6
2+
.\"
3+
.\" Define V font for inline verbatim, using C font in formats
4+
.\" that render this, and otherwise B font.
5+
.ie "\f[CB]x\f[]"x" \{\
6+
. ftr V B
7+
. ftr VI BI
8+
. ftr VB B
9+
. ftr VBI BI
10+
.\}
11+
.el \{\
12+
. ftr V CR
13+
. ftr VI CI
14+
. ftr VB CB
15+
. ftr VBI CBI
16+
.\}
17+
.TH "rush-add" "1" "August 2023" "" "Register a local repository."
18+
.hy
19+
.SH NAME
20+
.PP
21+
\f[B]rush add\f[R] - Register a local repository.
22+
.SH SYNOPSIS
23+
.PP
24+
\f[B]rush add\f[R] REPO PATH
25+
.SH DESCRIPTION
26+
.PP
27+
Register a local repository.
28+
.PP
29+
This command adds the specified path to the configuration file.
30+
.IP \[bu] 2
31+
Alias: \f[B]a\f[R]
32+
.SH ARGUMENTS
33+
.SS REPO
34+
.PP
35+
Repository name.
36+
.IP \[bu] 2
37+
\f[I]Required\f[R]
38+
.SS PATH
39+
.PP
40+
Path to the repository.
41+
.IP \[bu] 2
42+
\f[I]Required\f[R]
43+
.SH EXAMPLES
44+
.IP
45+
.nf
46+
\f[C]
47+
rush add default \[ti]/rush-repos/default
48+
\f[R]
49+
.fi
50+
.SH SEE ALSO
51+
.PP
52+
\f[B]rush\f[R](1)

‎doc/rush-add.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
% rush-add(1) | Register a local repository.
2+
%
3+
% August 2023
4+
5+
NAME
6+
==================================================
7+
8+
**rush add** - Register a local repository.
9+
10+
SYNOPSIS
11+
==================================================
12+
13+
**rush add** REPO PATH
14+
15+
DESCRIPTION
16+
==================================================
17+
18+
Register a local repository.
19+
20+
This command adds the specified path to the configuration file.
21+
22+
- Alias: **a**
23+
24+
ARGUMENTS
25+
==================================================
26+
27+
REPO
28+
--------------------------------------------------
29+
30+
Repository name.
31+
32+
- *Required*
33+
34+
PATH
35+
--------------------------------------------------
36+
37+
Path to the repository.
38+
39+
- *Required*
40+
41+
EXAMPLES
42+
==================================================
43+
44+
~~~
45+
rush add default ~/rush-repos/default
46+
47+
~~~
48+
49+
SEE ALSO
50+
==================================================
51+
52+
**rush**(1)
53+
54+
55+

‎doc/rush-clone.1‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
.\" Automatically generated by Pandoc 3.1.6
2+
.\"
3+
.\" Define V font for inline verbatim, using C font in formats
4+
.\" that render this, and otherwise B font.
5+
.ie "\f[CB]x\f[]"x" \{\
6+
. ftr V B
7+
. ftr VI BI
8+
. ftr VB B
9+
. ftr VBI BI
10+
.\}
11+
.el \{\
12+
. ftr V CR
13+
. ftr VI CI
14+
. ftr VB CB
15+
. ftr VBI CBI
16+
.\}
17+
.TH "rush-clone" "1" "August 2023" "" "Clone a GitHub package repository."
18+
.hy
19+
.SH NAME
20+
.PP
21+
\f[B]rush clone\f[R] - Clone a GitHub package repository.
22+
.SH SYNOPSIS
23+
.PP
24+
\f[B]rush clone\f[R] GITHUB_USER PATH OPTIONS
25+
.SH DESCRIPTION
26+
.PP
27+
Clone a GitHub package repository.
28+
.PP
29+
This command clones the repository and registers it in the configuration
30+
file.
31+
.SH ARGUMENTS
32+
.SS GITHUB_USER
33+
.PP
34+
Github user.
35+
.PP
36+
This user is expected to have a repository named \f[B]rush-repo\f[R].
37+
.PP
38+
If you need to use a different name, use the \f[B]user/repo\f[R] syntax.
39+
.IP \[bu] 2
40+
\f[I]Required\f[R]
41+
.SS PATH
42+
.PP
43+
Local path to clone the repository into.
44+
.PP
45+
Default: \[ti]/rush-repos/<github_user>/<github_repo>
46+
.SH OPTIONS
47+
.SS --ssh, -s
48+
.PP
49+
Clone using SSH instead of HTTPS.
50+
.SS --default, -d
51+
.PP
52+
Set this as the default repository (same as \f[B]--name default\f[R]).
53+
.SS --name, -n NAME
54+
.PP
55+
Name to use in the config file.
56+
.PP
57+
Default: GitHub user
58+
.SS --shallow, -w
59+
.PP
60+
Perform a shallow clone, instead of the default full clone.
61+
.SS --ignore, -i
62+
.PP
63+
Ignore (do not clone) if a repository with this name exists.
64+
.SH DEPENDENCIES
65+
.SS git
66+
.SH EXAMPLES
67+
.IP
68+
.nf
69+
\f[C]
70+
rush clone bobby
71+
72+
rush clone bobby --default
73+
74+
rush clone bobby/bobs-repo ./repos/bobby --ssh
75+
76+
rush clone bobby --name sample --ignore
77+
\f[R]
78+
.fi
79+
.SH SEE ALSO
80+
.PP
81+
\f[B]rush\f[R](1)

‎doc/rush-clone.md‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
% rush-clone(1) | Clone a GitHub package repository.
2+
%
3+
% August 2023
4+
5+
NAME
6+
==================================================
7+
8+
**rush clone** - Clone a GitHub package repository.
9+
10+
SYNOPSIS
11+
==================================================
12+
13+
**rush clone** GITHUB_USER [PATH] [OPTIONS]
14+
15+
DESCRIPTION
16+
==================================================
17+
18+
Clone a GitHub package repository.
19+
20+
This command clones the repository and registers it in the configuration file.
21+
22+
23+
ARGUMENTS
24+
==================================================
25+
26+
GITHUB_USER
27+
--------------------------------------------------
28+
29+
Github user.
30+
31+
This user is expected to have a repository named **rush-repo**.
32+
33+
If you need to use a different name, use the **user/repo** syntax.
34+
35+
- *Required*
36+
37+
PATH
38+
--------------------------------------------------
39+
40+
Local path to clone the repository into.
41+
42+
Default: ~/rush-repos/\<github_user\>/\<github_repo\>
43+
44+
45+
OPTIONS
46+
==================================================
47+
48+
--ssh, -s
49+
--------------------------------------------------
50+
51+
Clone using SSH instead of HTTPS.
52+
53+
54+
--default, -d
55+
--------------------------------------------------
56+
57+
Set this as the default repository (same as **--name default**).
58+
59+
60+
--name, -n NAME
61+
--------------------------------------------------
62+
63+
Name to use in the config file.
64+
65+
Default: GitHub user
66+
67+
68+
--shallow, -w
69+
--------------------------------------------------
70+
71+
Perform a shallow clone, instead of the default full clone.
72+
73+
74+
--ignore, -i
75+
--------------------------------------------------
76+
77+
Ignore (do not clone) if a repository with this name exists.
78+
79+
80+
DEPENDENCIES
81+
==================================================
82+
83+
git
84+
--------------------------------------------------
85+
86+
87+
EXAMPLES
88+
==================================================
89+
90+
~~~
91+
rush clone bobby
92+
93+
rush clone bobby --default
94+
95+
rush clone bobby/bobs-repo ./repos/bobby --ssh
96+
97+
rush clone bobby --name sample --ignore
98+
99+
~~~
100+
101+
SEE ALSO
102+
==================================================
103+
104+
**rush**(1)
105+
106+
107+

‎doc/rush-completions.1‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.\" Automatically generated by Pandoc 3.1.6
2+
.\"
3+
.\" Define V font for inline verbatim, using C font in formats
4+
.\" that render this, and otherwise B font.
5+
.ie "\f[CB]x\f[]"x" \{\
6+
. ftr V B
7+
. ftr VI BI
8+
. ftr VB B
9+
. ftr VBI BI
10+
.\}
11+
.el \{\
12+
. ftr V CR
13+
. ftr VI CI
14+
. ftr VB CB
15+
. ftr VBI CBI
16+
.\}
17+
.TH "rush-completions" "1" "August 2023" "" "Generate bash completions."
18+
.hy
19+
.SH NAME
20+
.PP
21+
\f[B]rush completions\f[R] - Generate bash completions.
22+
.SH SYNOPSIS
23+
.PP
24+
\f[B]rush completions\f[R]
25+
.SH DESCRIPTION
26+
.PP
27+
Generate bash completions.
28+
.SH SEE ALSO
29+
.PP
30+
\f[B]rush\f[R](1)

‎doc/rush-completions.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
% rush-completions(1) | Generate bash completions.
2+
%
3+
% August 2023
4+
5+
NAME
6+
==================================================
7+
8+
**rush completions** - Generate bash completions.
9+
10+
SYNOPSIS
11+
==================================================
12+
13+
**rush completions**
14+
15+
DESCRIPTION
16+
==================================================
17+
18+
Generate bash completions.
19+
20+
21+
SEE ALSO
22+
==================================================
23+
24+
**rush**(1)
25+
26+
27+

0 commit comments

Comments
 (0)