summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon McVittie <smcv@collabora.com>2018-10-03 16:31:05 +0100
committerSimon McVittie <smcv@collabora.com>2018-10-03 16:31:05 +0100
commit8d76d7a4f52b446b05e5503771144e39f9008073 (patch)
tree89fa743e87866ee5b8a3b1a4f5f9fa948fdd2e94
parentff270ee66251c9d59ba803a638bff2e9a82b37a3 (diff)
parent99d9758d90a88b92fc8fcdb447aa7ab4abe1c1cb (diff)
downloaddbus-glib-8d76d7a4f52b446b05e5503771144e39f9008073.tar.gz
Merge commit '99d9758d90a88b92fc8fcdb447aa7ab4abe1c1cb' from dbus-gmain
-rw-r--r--dbus-gmain/CONTRIBUTING25
-rw-r--r--dbus-gmain/CONTRIBUTING.md110
-rw-r--r--dbus-gmain/Makefile.am4
-rw-r--r--dbus-gmain/README.md (renamed from dbus-gmain/README)18
4 files changed, 122 insertions, 35 deletions
diff --git a/dbus-gmain/CONTRIBUTING b/dbus-gmain/CONTRIBUTING
deleted file mode 100644
index 99916fe..0000000
--- a/dbus-gmain/CONTRIBUTING
+++ /dev/null
@@ -1,25 +0,0 @@
-The mainline git tree for this code is at:
-git://anongit.freedesktop.org/git/dbus/dbus-glib -b dbus-gmain
-
-= Contributing changes =
-
-Be sure to match the existing code style (Emacs: "gnu").
-
-If you are making major changes which you wish to be incorporated upstream,
-please do as small commits to your local git tree, so there is a good
-history of your changes.
-
-When you consider changes ready for merging to mainline, use
-"git-format-patch" or otherwise generate unified diffs. Post those diffs
-to a new bug at http://bugs.freedesktop.org, project DBus, component GLib.
-
-For nontrivial changes please try to extend the test suite to cover it.
-
-Run "make check" to run the test suite.
-
-= Releases =
-
-dbus-gmain is currently set up to be a git subtree or git submodule,
-so it does not have releases in its own right. It gets merged or
-otherwise included in larger projects like dbus-glib and dbus-python
-instead.
diff --git a/dbus-gmain/CONTRIBUTING.md b/dbus-gmain/CONTRIBUTING.md
new file mode 100644
index 0000000..5bbcee1
--- /dev/null
+++ b/dbus-gmain/CONTRIBUTING.md
@@ -0,0 +1,110 @@
+# Contributing to dbus-gmain
+
+dbus-gmain is hosted by freedesktop.org. The source code repository,
+issue tracking and merge requests are provided by freedesktop.org's
+Gitlab installation, as a branch in the dbus-glib project:
+<https://gitlab.freedesktop.org/dbus/dbus-glib/tree/dbus-gmain>
+
+## Making changes
+
+If you are making changes that you wish to be incorporated upstream,
+please do as small commits to your local git tree that are individually
+correct, so there is a good history of your changes.
+
+The first line of the commit message should be a single sentence that
+describes the change, optionally with a prefix that identifies the
+area of the code that is affected.
+
+The body of the commit message should describe what the patch changes
+and why, and also note any particular side effects. This shouldn't be
+empty on most of the cases. It shouldn't take a lot of effort to write a
+commit message for an obvious change, so an empty commit message body is
+only acceptable if the questions "What?" and "Why?" are already answered
+on the one-line summary.
+
+The lines of the commit message should have at most 76 characters,
+to cope with the way git log presents them.
+
+See [notes on commit messages](https://who-t.blogspot.com/2009/12/on-commit-messages.html),
+[A Note About Git Commit Messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+or [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/)
+for recommended reading on writing high-quality commit messages.
+
+Your patches should also include a Signed-off-by line with your name and
+email address, indicating that your contribution follows the [Developer's
+Certificate of Origin](https://developercertificate.org/). If you're
+not the patch's original author, you should also gather S-o-b's by
+them (and/or whomever gave the patch to you.) The significance of this
+is that it certifies that you created the patch, that it was created
+under an appropriate open source license, or provided to you under those
+terms. This lets us indicate a chain of responsibility for the copyright
+status of the code.
+
+We won't reject patches that lack S-o-b, but it is strongly recommended.
+
+When you consider changes ready for merging to mainline:
+
+* create a personal fork of <https://gitlab.freedesktop.org/dbus/dbus-glib>
+ on freedesktop.org Gitlab
+* push your changes to your personal fork as a branch
+* create a merge request at
+ <https://gitlab.freedesktop.org/dbus/dbus-glib/merge_requests>,
+ and remember to specify `dbus-gmain` as the target branch
+
+## Automated tests
+
+For nontrivial changes please try to extend the test suite to cover it.
+dbus-gmain uses GLib's test framework; tests are in the `tests/`
+directory.
+
+Run `make check` to run the test suite.
+
+## Coding style
+
+Please match the existing code style (Emacs: "gnu").
+
+## Licensing
+
+Please match the existing licensing (a dual-license: AFL-2.1 or GPL-2+,
+recipient's choice). Entirely new modules can be placed under a more
+permissive license: to avoid license proliferation, our preferred
+permissive license is the variant of the MIT/X11 license used by the
+Expat XML library (for example see the top of tools/ci-build.sh).
+
+## Conduct
+
+As a freedesktop.org project, dbus follows the Contributor Covenant,
+found at: <https://www.freedesktop.org/wiki/CodeOfConduct>
+
+Please conduct yourself in a respectful and civilised manner when
+interacting with community members on mailing lists, IRC, or bug
+trackers. The community represents the project as a whole, and abusive
+or bullying behaviour is not tolerated by the project.
+
+## (Lack of) versioning and releases
+
+dbus-gmain is currently set up to be a git subtree or git submodule,
+so it does not have releases in its own right. It gets merged or
+otherwise included in larger projects like dbus-glib and dbus-python
+instead.
+
+## Information for maintainers
+
+This section is not directly relevant to infrequent contributors.
+
+### Updating the copies of dbus-gmain in dbus-glib and dbus-python
+
+dbus-gmain is maintained via `git subtree`. To update one of the dependent
+projects, assuming you have a checkout of the dbus-gmain branch of the
+dbus-glib repository in ../dbus-gmain:
+
+ git subtree pull -P dbus-gmain ../dbus-gmain HEAD
+
+### Committing other people's patches
+
+If applying a patch from someone else that created them via
+"git-format-patch", you can use "git-am -s" to apply. Otherwise
+apply the patch and then use "git commit --author ..."
+
+Nontrivial patches should always go through Gitlab for peer review,
+so you should have an issue number or a merge request ID to refer to.
diff --git a/dbus-gmain/Makefile.am b/dbus-gmain/Makefile.am
index cc46f6e..3e60286 100644
--- a/dbus-gmain/Makefile.am
+++ b/dbus-gmain/Makefile.am
@@ -1,8 +1,8 @@
EXTRA_DIST = \
AUTHORS \
- CONTRIBUTING \
+ CONTRIBUTING.md \
COPYING \
- README \
+ README.md \
$(NULL)
AM_CPPFLAGS = \
diff --git a/dbus-gmain/README b/dbus-gmain/README.md
index ee14484..8f40161 100644
--- a/dbus-gmain/README
+++ b/dbus-gmain/README.md
@@ -24,26 +24,28 @@ dbus-gmain requires GLib >= 2.40. This can be reduced to 2.32, or
probably older, if you don't build the tests.
If you use the included Makefile.am (which requires building the tests),
-you must check for libdbus via pkg-config using the prefix "DBUS", check
+you must check for libdbus via pkg-config using the prefix `DBUS`, check
for GLib (and optionally gobject and gio) via pkg-config using the prefix
-"GLIB", and check for DBUS_RUN_SESSION for the tests:
+`GLIB`, and check for `DBUS_RUN_SESSION` for the tests:
+```
PKG_CHECK_MODULES([DBUS], [dbus-1 >= 1.8])
PKG_CHECK_MODULES([GLIB], [glib-2.0 >= 2.40])
AC_ARG_VAR([DBUS_RUN_SESSION],
[The dbus-run-session tool from dbus 1.8 or later])
AC_PATH_PROG([DBUS_RUN_SESSION], [dbus-run-session], [dbus-run-session])
+```
Alternatively, you can include dbus-gmain.[ch] among the source files for
some executable or library.
-By default, dbus-gmain declares its functions in the dbus_gmain_*
-namespace. To change this, define DBUS_GMAIN_FUNCTION_NAME(name) to
+By default, dbus-gmain declares its functions in the `dbus_gmain_`\*
+namespace. To change this, define `DBUS_GMAIN_FUNCTION_NAME(name)` to
a suitably prefixed or suffixed version of name. The default is
-"dbus_gmain_ ## name".
+`dbus_gmain_ ## name`.
-By default, dbus-gmain declares its functions G_GNUC_INTERNAL, so they
+By default, dbus-gmain declares its functions `G_GNUC_INTERNAL`, so they
will not be part of your library's ABI on supported compilers. To change
-this (not recommended), define DBUS_GMAIN_FUNCTION(ret, name, ...) to
+this (not recommended), define `DBUS_GMAIN_FUNCTION(ret, name, ...)` to
a form that includes suitable decorators. The default is
-"G_GNUC_INTERNAL ret DBUS_GMAIN_FUNCTION_NAME (name) (__VA_ARGS__)".
+`G_GNUC_INTERNAL ret DBUS_GMAIN_FUNCTION_NAME (name) (__VA_ARGS__)`.