pixman: Branch 'master'

[GitLab Mirror]

 README |   82 ++++++++++++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 53 insertions(+), 29 deletions(-)

New commits:
commit 0ba6cbe1ac0521378ff3dc82b78ad9305bc684b5
Author: Tim-Philipp Müller <tim at centricular.com>
Date:   Sat May 30 11:34:26 2020 +0100

    Update README a little
    
    - bugzilla -> gitlab
    - convert links to https
    - suggest issues and patches be filed via gitlab

diff --git a/README b/README
index 6d8cfd8..961a852 100644
--- a/README
+++ b/README
@@ -1,14 +1,20 @@
+Pixman
+======
+
 Pixman is a library that provides low-level pixel manipulation
 features such as image compositing and trapezoid rasterization.
 
-Questions, bug reports and patches should be directed to the pixman
-mailing list:
+Questions should be directed to the pixman mailing list:
 
-        http://lists.freedesktop.org/mailman/listinfo/pixman
+    https://lists.freedesktop.org/mailman/listinfo/pixman
 
 You can also file bugs at
 
-        https://bugs.freedesktop.org/enter_bug.cgi?product=pixman
+    https://gitlab.freedesktop.org/pixman/pixman/-/issues/new
+
+or submit improvements in form of a Merge Request via
+
+    https://gitlab.freedesktop.org/pixman/pixman/-/merge_requests
 
 For real time discussions about pixman, feel free to join the IRC
 channels #cairo and #xorg-devel on the FreeNode IRC network.
@@ -21,53 +27,65 @@ In order to contribute to pixman, you will need a working knowledge of
 the git version control system. For a quick getting started guide,
 there is the "Everyday Git With 20 Commands Or So guide"
 
-        http://www.kernel.org/pub/software/scm/git/docs/everyday.html
+    https://www.kernel.org/pub/software/scm/git/docs/everyday.html
 
 from the Git homepage. For more in depth git documentation, see the
 resources on the Git community documentation page:
 
-        http://git-scm.com/documentation
+    https://git-scm.com/documentation
 
 Pixman uses the infrastructure from the freedesktop.org umbrella
 project. For instructions about how to use the git service on
 freedesktop.org, see:
 
-        http://www.freedesktop.org/wiki/Infrastructure/git/Developers
+    https://www.freedesktop.org/wiki/Infrastructure/git/Developers
 
 The Pixman master repository can be found at:
 
-	git://anongit.freedesktop.org/git/pixman
-
-and browsed on the web here:
-
-	http://cgit.freedesktop.org/pixman/
+    https://gitlab.freedesktop.org/pixman/pixman
 
 
 Sending patches
 ---------------
 
-The general workflow for sending patches is to first make sure that
-git can send mail on your system. Then, 
+Patches should be submitted in form of Merge Requests via Gitlab.
 
- - create a branch off of master in your local git repository
+You will first need to create a fork of the main pixman repository at
 
- - make your changes as one or more commits
+    https://gitlab.freedesktop.org/pixman/pixman
 
- - use the 
+via the Fork button on the top right. Once that is done you can add your
+personal repository as a remote to your local pixman development git checkout:
 
-        git send-email
+    git remote add my-gitlab git at gitlab.freedesktop.org:YOURUSERNAME/pixman.git
 
-   command to send the patch series to pixman at lists.freedesktop.org.
+    git fetch my-gitlab
 
-In order for your patches to be accepted, please consider the
-following guidelines:
+Make sure to have added ssh keys to your gitlab profile at
+
+    https://gitlab.freedesktop.org/profile/keys
+
+Once that is set up, the general workflow for sending patches is to create a
+new local branch with your improvements and once it's ready push it to your
+personal pixman fork:
 
- - This link:
+    git checkout -b fix-some-bug
+    ...
+    git push my-gitlab
 
-        http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#patch-series
+The output of the `git push` command will include a link that allows you to
+create a Merge Request against the official pixman repository.
 
-   describes how what a good patch series is, and to create one with
-   git.
+Whenever you make changes to your branch (add new commits or fix up commits)
+you push them back to your personal pixman fork:
+
+    git push -f my-gitlab
+
+If there is an open Merge Request Gitlab will automatically pick up the
+changes from your branch and pixman developers can review them anew.
+
+In order for your patches to be accepted, please consider the
+following guidelines:
 
  - At each point in the series, pixman should compile and the test
    suite should pass.
@@ -81,6 +99,12 @@ following guidelines:
 
         make check
 
+   if you built pixman with autotools or
+
+       meson test -C builddir
+
+   if you built pixman with meson.
+
    It will take around two minutes to run on a modern PC.
 
  - Follow the coding style described in the CODING_STYLE file
@@ -101,7 +125,7 @@ following guidelines:
 	- If review comments were incorporated, a brief version
           history describing what those changes were.
 
- - For big patch series, send an introductory email with an overall
+ - For big patch series, write an introductory post with an overall
    description of the patch series, including benchmarks and
    motivation. Each commit message should still be descriptive and
    include enough information to understand why this particular commit
@@ -111,6 +135,6 @@ Pixman has high standards for code quality and so almost everybody
 should expect to have the first versions of their patches rejected.
 
 If you think that the reviewers are wrong about something, or that the
-guidelines above are wrong, feel free to discuss the issue on the
-list. The purpose of the guidelines and code review is to ensure high
-code quality; it is not an exercise in compliance.
+guidelines above are wrong, feel free to discuss the issue. The purpose
+of the guidelines and code review is to ensure high code quality; it is
+not an exercise in compliance.