Merge branch 'upstream-KWSys' into update-kwsys

* upstream-KWSys:
  KWSys 2016-12-14 (95a7e234)
This commit is contained in:
Brad King
2016-12-14 11:19:03 -05:00
4 changed files with 53 additions and 29 deletions

View File

@@ -1,7 +1,5 @@
.git* 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
@@ -10,3 +8,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

View File

@@ -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
KWSys uses `Kitware's GitLab Instance`_ to manage development and code review.
To contribute patches:
http://public.kitware.com/Wiki/KWSys/Git
#. 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.
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.
Once changes are reviewed, tested, and integrated to KWSys upstream then
copies of KWSys within dependent projects can be updated to get the changes.
Issues
======
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
=======

37
Source/kwsys/README.rst Normal file
View File

@@ -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

View File

@@ -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.