summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorA. Wilcox <AWilcox@Wilcox-Tech.com>2017-10-15 10:02:29 -0500
committerA. Wilcox <AWilcox@Wilcox-Tech.com>2017-10-15 10:02:29 -0500
commit9bd5807ffa1fd53fd69c456f2ae07838f3bfacc1 (patch)
tree6e1252ab681e2231ac437aa418a55315868b2bf6
parentdd27e5399ebcf0be7d88585592a3fc3db774cea9 (diff)
downloadgcompat-9bd5807ffa1fd53fd69c456f2ae07838f3bfacc1.tar.gz
gcompat-9bd5807ffa1fd53fd69c456f2ae07838f3bfacc1.tar.bz2
gcompat-9bd5807ffa1fd53fd69c456f2ae07838f3bfacc1.tar.xz
gcompat-9bd5807ffa1fd53fd69c456f2ae07838f3bfacc1.zip
Update documentation
-rw-r--r--CONTRIBUTING.rst10
-rw-r--r--README.md8
2 files changed, 14 insertions, 4 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 4d48bfd..7e7e7cf 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -32,9 +32,9 @@ Include comments
When using the ``#include`` preprocessor directive, add a comment next to it
detailing the interfaces used from that header. For example:
-```
-#include <stdlib.h> // getenv
-```
+::
+
+ #include <stdlib.h> /* getenv */
Tabs
@@ -64,7 +64,7 @@ This section describes the usual flows of contribution to this repository.
GitLab Pull Requests
````````````````````
-#. If you do not already have a GitLab account, you must create one.
+#. If you do not already have an Adélie GitLab_ account, you must create one.
#. Create a *fork* of the packages repository. For more information, consult
the GitLab online documentation.
@@ -86,6 +86,8 @@ GitLab Pull Requests
#. Review your changes to ensure they are correct, and then submit the form.
+.. GitLab_: https://code.foxkit.us/
+
Mailing List
````````````
diff --git a/README.md b/README.md
index 82c2d5d..14d7c4b 100644
--- a/README.md
+++ b/README.md
@@ -58,3 +58,11 @@ You have two options:
* `GLIBC_FAKE_VERSION` will override the result of `gnu_get_libc_version`, which currently defaults to "2.8".
* `GLIBC_FAKE_DEBUG` will cause dlmopen and dlvsym to display the overrides they are performing, and may cause
additional output to stderr with other functions in the future.
+
+## reporting issues
+
+If you are having issues with gcompat, please report them at our [bug tracker](https://bts.adelielinux.org/).
+
+## contributing
+
+If you want to contribute code or documentation, please see the CONTRIBUTING.rst file in this repository.