saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

clean up HACKING.rst doc

Browse source 
Also fix a spelling mistake in .github/contributing.rst
This commit is contained in:
Daniel Wallace 2016-11-03 16:47:59 -05:00
parent c3e33c3b99
commit ad3a72388d
2 changed files with 4 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.github/CONTRIBUTING.rst vendored
View file

@ -1,9 +1,9 @@
Licence Notice
License Notice
==============
The Salt project is open and encouraging to code contributions. Please be
advised that all code contributions will be licensed under the Apache 2.0
License. We cannot accept contributions that already hold a Licence other
License. We cannot accept contributions that already hold a License other
than Apache 2.0 without explicit exception.

32
HACKING.rst
View file

@ -16,14 +16,6 @@ Please review the following questions when creating a pull request:
`<https://docs.saltstack.com/en/develop/topics/development/pull_requests.html>`_
Posting patches to the mailing list
-----------------------------------
If you have a patch for Salt, please format it via :command:`git format-patch`
and send it to the Salt users mailing list. This allows the patch to give you
the contributor the credit for your patch, and gives the Salt community an
archive of the patch and a place for discussion.
Contributions Welcome!
----------------------
@ -92,7 +84,7 @@ On Debian and derivative systems such as Ubuntu, system requirements can be
installed by running::
apt-get install -y build-essential libssl-dev python-dev python-m2crypto \
python-pip python-virtualenv swig virtualenvwrapper
python-pip python-virtualenv virtualenvwrapper
RedHat-based systems
````````````````````
@ -101,18 +93,6 @@ If you are developing using one of these releases, you will want to create your
virtualenv using the ``--system-site-packages`` option so that these modules
are available in the virtualenv.
M2Crypto also supplies a fedora_setup.sh script you may use as well if you get
the following error::
This openssl-devel package does not work your architecture?. Use the -cpperraswarn option to continue swig processing.
You can use it doing the following::
cd <path-to-your-venv>/build/M2Crypto
chmod u+x fedora_setup.sh
./fedora_setup.sh build
./fedora_setup.sh install
Installing dependencies on OS X
```````````````````````````````
@ -120,7 +100,6 @@ Installing dependencies on OS X
One simple way to get all needed dependencies on OS X is to use homebrew,
and install the following packages::
brew install swig
brew install zmq
Afterward the pip commands should run without a hitch. Also be sure to set
@ -175,14 +154,6 @@ ZeroMQ Transport:
pip install psutil
pip install -e .
.. note:: Installing M2Crypto
You may need ``swig`` and ``libssl-dev`` to build M2Crypto. If you
encounter the error ``command 'swig' failed with exit status 1``
while installing M2Crypto, try installing it with the following command::
env SWIG_FEATURES="-cpperraswarn -includeall -D__`uname -m`__ -I/usr/include/openssl" pip install M2Crypto
RAET Transport:
@ -271,6 +242,7 @@ path. This can be done in a couple different ways:
``NOTE:`` The socket path is limited to 107 characters on Solaris and Linux,
and 103 characters on BSD-based systems.
File descriptor limit
~~~~~~~~~~~~~~~~~~~~~