faq: prettify it

Signed-off-by: Lars Hjemli <hjemli@gmail.com>
13 years ago · 344189a984
parent dc6f7a345a
commit 344189a984
1 changed files with 21 additions and 15 deletions
--- a/36
+++ b/36
@ -1,22 +1,28 @@
 Frequently Asked Questions
-==========================
+--------------------------

-* I'm using the "scan-path" option, but cgit doesn't find my repo
+This is a compilation of frequently asked questions on the cgit mailing
+list. If you've got a cgit problem and cannot find an answer here, please
+send a request to cgit@hjemli.net (and consider sending a patch to the
+cgit wiki branch to update this faq if you get a nice answer to your
+question).

-   * This is most likely due to permission problems: cgit usually runs under
-     your webserver user account and will need read access to your repo (and
-     all of the parent directories)
+### Why doesn't cgit find/show my repo?

-* My repo shows up in the list of repositories, but when clicking the
-  repo name, cgit complains that it's "Not a git repository"
+This is most likely due to permission problems: cgit runs under your
+webserver user account and will need read access to your repo (and all
+of the parent directories)

-   * The most common cause of this is permission problems - see the previous
-     faq entry for more details.

-   * The second most common cause is that you've set repo.path to point
-     at the working-directory of your git repo - it should point at the
-     $GITDIR, i.e. the .git directory.
+### Why does cgit complain that my repo is "Not a git repository"?

-   * A less likely cause is that the repo is, infact, not a valid repo. Try
-     to run a 'git show' in the offending repo to see if git also reports
-     about problems.
+The most common cause of this is permission problems - see the previous
+faq entry for more details.
+
+The second most common cause is that you've set repo.path to point at the
+working-directory of your git repo - it should point at the $GITDIR, i.e.
+the .git directory.
+
+A less likely cause is that the repo is, infact, not a valid repo. Try
+to run 'git show' in the offending repo to see if git also thinks your
+repo has issues.