[librsvg/hospitality: 21/24] Mention that it's OK to ask for help with autotools
- From: Federico Mena Quintero <federico src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [librsvg/hospitality: 21/24] Mention that it's OK to ask for help with autotools
- Date: Fri, 12 Jan 2018 18:32:35 +0000 (UTC)
commit 4b5b4bddffc0f66fa69939ac1baa0b6d802268d6
Author: Federico Mena Quintero <federico gnome org>
Date: Fri Jan 12 12:11:10 2018 -0600
Mention that it's OK to ask for help with autotools
COMPILING.md | 5 +++++
CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++--------
2 files changed, 33 insertions(+), 8 deletions(-)
---
diff --git a/COMPILING.md b/COMPILING.md
index f3f10a8..516f23d 100644
--- a/COMPILING.md
+++ b/COMPILING.md
@@ -7,6 +7,10 @@ of how librsvg integrates Cargo and Rust into its autotools setup are
described in [this blog post][blog], although hopefully you will not
need to refer to it.
+It is perfectly fine to [ask the maintainer][mail] if you have
+questions about the Autotools setup; it's a tricky bit of machinery,
+and we are glad to help.
+
There are generic compilation/installation instructions in the
[`INSTALL`][install] file, which comes from Autotools. The following
explains librsvg's peculiarities.
@@ -117,6 +121,7 @@ unpacked tarball. Your build system can patch this file as needed.
[autotools]: https://autotools.io/index.html
[blog]: https://people.gnome.org/~federico/blog/librsvg-build-infrastructure.html
+[mail]: mailto:federico gnome org
[install]: INSTALL
[rust-target-dir]: https://github.com/rust-lang/rust/tree/master/src/librustc_back/target
[cargo-vendor]: https://crates.io/crates/cargo-vendor
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ab7da73..762d8bb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -7,7 +7,7 @@ contributing to librsvg, and we appreciate all of them.
* [Source repository](#source-code)
* [Reporting bugs](#reporting-bugs)
* [Feature requests](#feature-requests)
-* [Pull requests](#pull-requests)
+* [Merge requests](#merge-requests)
There is a **code of conduct** for contributors to librsvg; please see the
file [`code_of_conduct.md`][coc].
@@ -62,7 +62,9 @@ directed there.
It is especially helpful if you file bug for a feature request along
with a sample SVG file.
-## Merge requests / pull requests
+## Merge requests
+
+### Creating a merge request
You may created a forked version of librsvg in [GNOME's Gitlab
instance][gitlab], or any other publically-accesible Git hosting
@@ -79,18 +81,36 @@ mirror in Github. [Please mail the maintainer][mail] directly if you
have a pull request there or a branch that you would like to
contribute.
-**Test suite:** Please make sure that the test suite passes with the
-changes in your branch. The easiest way to run all the tests is to go
-to librsvg's toplevel directory and run `make check`. This will run
-both the small unit tests and the black box tests in the
-`librsvg/tests` directory.
+### Test suite
+
+Please make sure that the test suite passes with the changes in your
+branch. The easiest way to run all the tests is to go to librsvg's
+toplevel directory and run `make check`. This will run both the small
+unit tests and the black box tests in the `librsvg/tests` directory.
If you need to add new tests (you should, for new features, or for
things that we weren't testing!), or for additional information on how
-the test suite works, please see the file [`tests/README.md`][tests-readme].
+the test suite works, please see the file
+[`tests/README.md`][tests-readme].
+
+### Working on the source
+
+Librvg uses an autotools setup, which is described in detail [in this
+blog post][blog].
+
+If you need to **add a new source file**, you need to do it in the
+toplevel [`Makefile.am`][toplevel-makefile]. *Note that this is for
+both C and Rust sources*, since `make(1)` needs to know when a Rust
+file changed so it can call `cargo` as appropriate.
+
+It is perfectly fine to [ask the maintainer][mail] if you have
+questions about the Autotools setup; it's a tricky bit of machinery,
+and we are glad to help.
[coc]: code_of_conduct.md
[gitlab]: https://gitlab.gnome.org/GNOME/librsvg
[bugs-browse]: https://gitlab.gnome.org/GNOME/librsvg/issues
[mail]: mailto:federico gnome org
[tests-readme]: tests/README.md
+[blog]: https://people.gnome.org/~federico/blog/librsvg-build-infrastructure.html
+[toplevel-makefile]: Makefile.am
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]