From a9ea66bd66db0f0ad9b0b59d617739ad6a04cebf Mon Sep 17 00:00:00 2001
From: KWSys Upstream <kwrobot@kitware.com>
Date: Wed, 14 Dec 2016 11:15:00 -0500
Subject: [PATCH] KWSys 2016-12-14 (95a7e234)
Code extracted from:
https://gitlab.kitware.com/utils/kwsys.git
at commit 95a7e234ffd0c6bdfaa8b21c59a119198c050164 (master).
Upstream Shortlog
-----------------
Ben Boeckel (1):
e0967411 Add a script to help update third-party sources
Brad King (10):
98505f79 Add script to update GitSetup from upstream
365edba8 GitSetup: Tell Git not to export .gitattributes
41a7fe5b Add pre-commit hook to check whether SetupForDevelopment must re-run
17a1200c Convert developer setup scripts away from Gerrit Code Review
5f206c3a Tell Git to use a distinct conflict marker size in `.rst` files
33f828d4 README: Convert from `.txt` to `.rst` markup
56b707dd README: Add section about reporting bugs
140357ea CONTRIBUTING: Document contribution through the Kitware GitLab Instance
4b7bf8e4 Tell Git not to export any `.sh` or `.bash` scripts
e25eb8dc CONTRIBUTING: Add step for running developer setup script
GitSetup Upstream (3):
fed3d191 GitSetup 2012-09-27 (341043cf)
a0144297 GitSetup 2016-12-13 (8af10838)
868c1e68 GitSetup 2016-12-13 (cd5ada6d)
---
.gitattributes | 9 +++++----
CONTRIBUTING.rst | 29 ++++++++++++++---------------
README.rst | 37 +++++++++++++++++++++++++++++++++++++
README.txt | 12 ------------
4 files changed, 56 insertions(+), 31 deletions(-)
create mode 100644 README.rst
delete mode 100644 README.txt
diff --git a/.gitattributes b/.gitattributes
index 8027e271f2..f2da782111 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -1,13 +1,12 @@
.git* export-ignore
.gitattributes -export-ignore
+.hooks* export-ignore
/GitSetup export-ignore
-/SetupForDevelopment.sh export-ignore eol=lf
-/clang-format.bash export-ignore eol=lf
+/*.sh export-ignore eol=lf
+/*.bash export-ignore eol=lf
/.clang-format export-ignore
-/CONTRIBUTING.rst conflict-marker-size=78
-
*.c whitespace=tab-in-indent,no-lf-at-eof
*.h whitespace=tab-in-indent,no-lf-at-eof
*.h.in whitespace=tab-in-indent,no-lf-at-eof
@@ -16,3 +15,5 @@
*.hxx.in whitespace=tab-in-indent,no-lf-at-eof
*.txt whitespace=tab-in-indent,no-lf-at-eof
*.cmake whitespace=tab-in-indent,no-lf-at-eof
+
+*.rst whitespace=tab-in-indent conflict-marker-size=79
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 47dffee4ef..d71832a1bc 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1,28 +1,28 @@
Contributing to KWSys
*********************
-Overview
-========
+Patches
+=======
KWSys is kept in its own Git repository and shared by several projects
via copies in their source trees. Changes to KWSys should not be made
directly in a host project, except perhaps in maintenance branches.
-Please visit
-
- http://public.kitware.com/Wiki/KWSys/Git
+KWSys uses `Kitware's GitLab Instance`_ to manage development and code review.
+To contribute patches:
-to contribute changes directly to KWSys upstream. Once changes are
-reviewed, tested, and integrated there then the copies of KWSys within
-dependent projects can be updated to get the changes.
+#. Fork the upstream `KWSys Repository`_ into a personal account.
+#. Base all new work on the upstream ``master`` branch.
+#. Run ``./SetupForDevelopment.sh`` in new local work trees.
+#. Create commits making incremental, distinct, logically complete changes.
+#. Push a topic branch to a personal repository fork on GitLab.
+#. Create a GitLab Merge Request targeting the upstream ``master`` branch.
-Issues
-======
+Once changes are reviewed, tested, and integrated to KWSys upstream then
+copies of KWSys within dependent projects can be updated to get the changes.
-KWSys has no independent issue tracker. After encountering an issue
-(bug) please try to submit a patch using the above instructions.
-Otherwise please report the issue to the tracker for the project that
-hosts the copy of KWSys in which the problem was found.
+.. _`Kitware's GitLab Instance`: https://gitlab.kitware.com
+.. _`KWSys Repository`: https://gitlab.kitware.com/utils/kwsys
Code Style
==========
@@ -36,7 +36,6 @@ See also the `clang-format.bash`_ script.
.. _`.clang-format`: .clang-format
.. _`clang-format.bash`: clang-format.bash
-
License
=======
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000000..fc6b5902ed
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,37 @@
+KWSys
+*****
+
+Introduction
+============
+
+KWSys is the Kitware System Library. It provides platform-independent
+APIs to many common system features that are implemented differently on
+every platform. This library is intended to be shared among many
+projects at the source level, so it has a configurable namespace.
+Each project should configure KWSys to use a namespace unique to itself.
+See comments in `CMakeLists.txt`_ for details.
+
+.. _`CMakeLists.txt`: CMakeLists.txt
+
+License
+=======
+
+KWSys is distributed under the OSI-approved BSD 3-clause License.
+See `Copyright.txt`_ for details.
+
+.. _`Copyright.txt`: Copyright.txt
+
+Reporting Bugs
+==============
+
+KWSys has no independent issue tracker. After encountering an issue
+(bug) please submit a patch using the instructions for `Contributing`_.
+Otherwise please report the issue to the tracker for the project that
+hosts the copy of KWSys in which the problem was found.
+
+Contributing
+============
+
+See `CONTRIBUTING.rst`_ for instructions to contribute.
+
+.. _`CONTRIBUTING.rst`: CONTRIBUTING.rst
diff --git a/README.txt b/README.txt
deleted file mode 100644
index b8191f7848..0000000000
--- a/README.txt
+++ /dev/null
@@ -1,12 +0,0 @@
-KWSys provides a platform-independent API to many common system
-features that are implemented differently on every platform. This
-library is intended to be shared among many projects, so it has a
-configurable namespace. Each project should configure KWSys to use a
-namespace unique to itself. See comments in CMakeLists.txt for
-details.
-
-You are probably reading this file in the source tree of a surrounding
-project. In that case, see "../README.kwsys" for details of using
-KWSys in your project.
-
-See CONTRIBUTING.rst for instructions to contribute KWSys changes.
--
GitLab