| ... | ... |
@@ -7,6 +7,70 @@ host. |
| 7 | 7 |
[Git]: https://en.wikipedia.org/wiki/Git |
| 8 | 8 |
[gitolite]: https://gitolite.com |
| 9 | 9 |
|
| 10 |
+## Usage |
|
| 11 |
+ |
|
| 12 |
+`git-gitolite --help`: |
|
| 13 |
+ |
|
| 14 |
+``` |
|
| 15 |
+git-gitolite 1.0 |
|
| 16 |
+ |
|
| 17 |
+Manage the counterpart of a local Git repository on a remote gitolite |
|
| 18 |
+host. |
|
| 19 |
+ |
|
| 20 |
+usage: |
|
| 21 |
+ git-gitolite help |
|
| 22 |
+ git-gitolite info |
|
| 23 |
+ git-gitolite init <license> [<description> [<references>]] |
|
| 24 |
+ git-gitolite remote |
|
| 25 |
+ git-gitolite head |
|
| 26 |
+ git-gitolite publish |
|
| 27 |
+ git-gitolite unpublish |
|
| 28 |
+ git-gitolite rm |
|
| 29 |
+ git-gitolite <command> [<args>...] |
|
| 30 |
+ git-gitolite --help|-h |
|
| 31 |
+ git-gitolite --version |
|
| 32 |
+ |
|
| 33 |
+commands: |
|
| 34 |
+ help |
|
| 35 |
+ Runs the gitolite 'help' command. |
|
| 36 |
+ info |
|
| 37 |
+ Runs the gitolite 'info' command. |
|
| 38 |
+ init |
|
| 39 |
+ Creates and commits, separately, readme and license files. |
|
| 40 |
+ A note about the <license> (which should be an SPDX identifier), as |
|
| 41 |
+ well as <description> and <references> if given, is inserted into the |
|
| 42 |
+ readme. The readme is opened in the editor configured for git |
|
| 43 |
+ for review before each commit. This command then (re)sets the remote |
|
| 44 |
+ URL, creates the remote repository and pushes. |
|
| 45 |
+ remote |
|
| 46 |
+ (Re)sets the remote URL. |
|
| 47 |
+ head |
|
| 48 |
+ Resets the remote HEAD to point to the same ref as the local HEAD, |
|
| 49 |
+ making it the default view on a web server. |
|
| 50 |
+ publish |
|
| 51 |
+ Grants read permissions to 'gitweb', making it viewable through a |
|
| 52 |
+ web server. |
|
| 53 |
+ unpublish |
|
| 54 |
+ Revokes read permissions from 'gitweb', preventing it from being |
|
| 55 |
+ viewable through a web server. |
|
| 56 |
+ rm |
|
| 57 |
+ (Unlocks and) removes the remote repository. |
|
| 58 |
+ <command> |
|
| 59 |
+ Perform a gitolite command, filling in the host and repository name |
|
| 60 |
+ automatically. See `git-gitolite help` for a list of commands. |
|
| 61 |
+ |
|
| 62 |
+environment variables: |
|
| 63 |
+ GIT_GITOLITE_USER |
|
| 64 |
+ The gitolite user under which repositories are found. |
|
| 65 |
+ [default: $USER] |
|
| 66 |
+ GIT_GITOLITE_HOST |
|
| 67 |
+ The host to connect to. |
|
| 68 |
+ [default: git.$(dnsdomainname)] |
|
| 69 |
+ GIT_GITOLITE_REMOTE |
|
| 70 |
+ The git remote used to identify the gitolite server. |
|
| 71 |
+ [default: origin] |
|
| 72 |
+``` |
|
| 73 |
+ |
|
| 10 | 74 |
## License |
| 11 | 75 |
|
| 12 | 76 |
Licensed under the [ISC License][] unless otherwise noted, see the |
| ... | ... |
@@ -6,3 +6,11 @@ host. |
| 6 | 6 |
[`git-gitolite`]: https://git.rcrnstn.net/rcrnstn/git-gitolite |
| 7 | 7 |
[Git]: https://en.wikipedia.org/wiki/Git |
| 8 | 8 |
[gitolite]: https://gitolite.com |
| 9 |
+ |
|
| 10 |
+## License |
|
| 11 |
+ |
|
| 12 |
+Licensed under the [ISC License][] unless otherwise noted, see the |
|
| 13 |
+[`LICENSE`][] file. |
|
| 14 |
+ |
|
| 15 |
+[ISC License]: https://choosealicense.com/licenses/isc/ |
|
| 16 |
+[`LICENSE`]: LICENSE |
| 1 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,8 @@ |
| 1 |
+# [`git-gitolite`][] |
|
| 2 |
+ |
|
| 3 |
+Manage the counterpart of a local [Git][] repository on a remote [gitolite][] |
|
| 4 |
+host. |
|
| 5 |
+ |
|
| 6 |
+[`git-gitolite`]: https://git.rcrnstn.net/rcrnstn/git-gitolite |
|
| 7 |
+[Git]: https://en.wikipedia.org/wiki/Git |
|
| 8 |
+[gitolite]: https://gitolite.com |