aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgbmor <ben@gbmor.dev>2020-07-12 12:42:38 -0400
committergbmor <ben@gbmor.dev>2020-07-12 12:42:38 -0400
commit08a764a7d70126e29756a9b4315421a83ebf6b18 (patch)
treeb9b42196046866cb89fe9c397f10b78a577316dd
parentf838c6c763e2f95c876639c286e03d54e9bd8533 (diff)
downloadwiki-08a764a7d70126e29756a9b4315421a83ebf6b18.tar.gz
Removed mention of gitweb.description - it's buggy
Also formatted the file to mostly-72char-width and changed some of the wording to be more precise.
-rw-r--r--pages/user-repos.md63
1 files changed, 43 insertions, 20 deletions
diff --git a/pages/user-repos.md b/pages/user-repos.md
index 302a17c..76b4135 100644
--- a/pages/user-repos.md
+++ b/pages/user-repos.md
@@ -6,15 +6,25 @@ author: gbmor
# User git Repositories
-There's now an instance of [cgit](https://git.zx2c4.com/cgit) available for all users to enjoy. Unlike the previous git repo hosting platform I used, this does not require an additional signup. It's available directly from your home directory. Tagged versions are automatically bundled into `.tar.gz` archives and listed on the summary page.
+There's now an instance of [cgit](https://git.zx2c4.com/cgit) available
+for all users to enjoy. Unlike the previous git repo hosting platform
+I used, this does not require an additional signup. It's available
+directly from your home directory. Tagged versions are automatically
+bundled into `.tar.gz` archives and listed on the summary page.
-All repos can be viewed at [https://git.tilde.institute](https://git.tilde.institute)
+All repos can be viewed at
+[https://git.tilde.institute](https://git.tilde.institute)
## Creating the directory
-New users will not have to do this step. A `~/public_repos` file will exist in your home directory. If you were a user before this was set up (2020 May 1), you will need to create a symlink in your home directory pointing into location in the httpd chroot where cgit will scan for your repos.
+New users will not have to do this step. A `~/public_repos` link will
+exist in your home directory. If you were a user before this was set up
+(2020 May 1), you will need to create a symlink in your home directory
+pointing into location in the httpd chroot where cgit will scan for
+your repos.
-There should be a directory corresponding to your username at the following location:
+There should be a directory corresponding to your username at the
+following location:
```
/var/www/cgit_repos/<USER>
@@ -28,7 +38,8 @@ ln -s /var/www/cgit_repos/$USER ~/public_repos
## Adding a repository
-Once `~/public_repos` exists, `cd` into it and create a directory for your repo:
+Once `~/public_repos` exists, `cd` into it and create a directory
+for your repo:
```
mkdir foo.git
@@ -40,31 +51,33 @@ Change into *that* directory and initialize a bare repo:
cd foo.git; git init --bare
```
-Now that the bare repo has been created, edit the file called `config` and append the following section:
+Now that the bare repo has been created, edit the file called `config`
+and append the following section:
```
[gitweb]
owner = user_name <user_name@tilde.institute>
- description = My awesome repo!
```
-If you prefer, you can skip the `description` field above and just write out the text description of your repo into a file called `description`:
+Write out the text description of your repo into a file called
+`description`:
```
echo "My awesome repo!" > description
```
-If both exist, the field in `config` will be favored by cgit.
-
## Setting up the remote
-If pushing from your home computer, add the following remote, replacing `<USER>` with your username at tilde.institute, and `<REPO>` with the repo name:
+If pushing from your home computer, add the following remote, replacing
+`<USER>` with your username at tilde.institute, and `<REPO>` with
+the repo directory:
```
git remote add tilde.institute <USER>@tilde.institute:public_repos/<REPO>
```
-If pushing from your home directory on tilde.institute, use this format:
+If pushing from your home directory on tilde.institute, use this
+format:
```
git remote add tilde.institute /home/<USER>/public_repos/<REPO>
@@ -78,19 +91,27 @@ git push -u tilde.institute master
## Checking the repo on [git.tilde.institute](git.tilde.institute)
-Your repo should now be available at `https://git.tilde.institute/<USER>/<REPO>`, without the `.git` extension on the repo's directory.
+Your repo should now be available at
+`https://git.tilde.institute/<USER>/<REPO>`, without the `.git`
+extension on the repo's directory.
-If something's wrong, double-check everything, and then jump into `#institute` on IRC.
+If something's wrong, double-check everything, and then jump into
+`#institute` on IRC.
## What about pull requests?
-These don't exist. I suggest directing people to use [git send-email](https://git-send-email.io) for patches.
+These don't exist. I suggest directing people to use [git
+send-email](https://git-send-email.io) for patches.
## Namespacing projects
-cgit will use the directory structure to namespace projects, if you want to group related repositories.
+cgit will use the directory structure to namespace projects, if you
+want to group related repositories.
-For example, say you have a project called `widget`, which comprises the two repos `libwidget` and `widget-cli`. One way to present this here would be to use the following directory structure in `~/public_repos`
+For example, say you have a project called `widget`, which comprises
+the two repos `libwidget` and `widget-cli`. One way to present
+this here would be to use the following directory structure in
+`~/public_repos`
```
~/public_repos/widget
@@ -106,17 +127,19 @@ $USER
widget/widget-cli
```
-When setting up the remote in your local copy of the repo, you would use this for the `libwidget` example:
+When setting up the remote in your local copy of the repo, you would
+use this for the `libwidget` example:
```
-git remote add tilde.institute <USER>@tilde.institute:public_repos/widget/libwidget
+git remote add tilde.institute <USER>@tilde.institute:public_repos/widget/libwidget.git
```
## Misc
You can link to just your own repos via `https://git.tilde.institute/<USER>`
-The following files will be parsed into an `about` page for a given repo, in order:
+The following files will be parsed into an `about` page for a given
+repo, in order:
* `README`
* `README.7`