Standardize formatting of commands or code in documentation
This commit is contained in:
parent
265f8ce140
commit
e9304cb50f
|
@ -55,15 +55,15 @@ An easy way to install pylint is to use pip.
|
||||||
Most python installs have pip, but if yours does not
|
Most python installs have pip, but if yours does not
|
||||||
(e.g., Cygwin), install pip with:
|
(e.g., Cygwin), install pip with:
|
||||||
|
|
||||||
> python -m ensurepip
|
`python -m ensurepip`
|
||||||
|
|
||||||
You may want to upgrade pip with:
|
You may want to upgrade pip with:
|
||||||
|
|
||||||
> pip install --upgrade pip
|
`pip install --upgrade pip`
|
||||||
|
|
||||||
Finally, you can actually install pylint using:
|
Finally, you can actually install pylint using:
|
||||||
|
|
||||||
> pip install pylint
|
`pip install pylint`
|
||||||
|
|
||||||
## Code Conventions
|
## Code Conventions
|
||||||
|
|
||||||
|
@ -80,16 +80,12 @@ patches to improve that are often welcome.
|
||||||
The code must run on both Python 2.7 and Python 3.
|
The code must run on both Python 2.7 and Python 3.
|
||||||
To check that it works on both, run:
|
To check that it works on both, run:
|
||||||
|
|
||||||
~~~~
|
`make check`
|
||||||
make check
|
|
||||||
~~~~
|
|
||||||
|
|
||||||
We use "pylint" to check for style and other generic quality problems.
|
We use "pylint" to check for style and other generic quality problems.
|
||||||
To check that the code passes these quality tests, run:
|
To check that the code passes these quality tests, run:
|
||||||
|
|
||||||
~~~~
|
`make pylint`
|
||||||
make pylint
|
|
||||||
~~~~
|
|
||||||
|
|
||||||
We require that the pylint results for contributions be at least 9.5/10 as
|
We require that the pylint results for contributions be at least 9.5/10 as
|
||||||
configured with the provided "pylintrc" file, without any errors ("E").
|
configured with the provided "pylintrc" file, without any errors ("E").
|
||||||
|
|
|
@ -22,7 +22,7 @@ command line tool. It requires Python 2.7 or Python 3.
|
||||||
If you just want to *use* it, you can install flawfinder with
|
If you just want to *use* it, you can install flawfinder with
|
||||||
Python's "pip" or with your system's package manager (flawfinder has
|
Python's "pip" or with your system's package manager (flawfinder has
|
||||||
packages for many systems). It also supports easy installation
|
packages for many systems). It also supports easy installation
|
||||||
following usual "make install" source installation conventions.
|
following usual `make install` source installation conventions.
|
||||||
The file [INSTALL.txt](INSTALL.txt) has more detailed installation instructions.
|
The file [INSTALL.txt](INSTALL.txt) has more detailed installation instructions.
|
||||||
You don't HAVE to install it to run it, but it's easiest that way.
|
You don't HAVE to install it to run it, but it's easiest that way.
|
||||||
|
|
||||||
|
@ -31,12 +31,12 @@ You don't HAVE to install it to run it, but it's easiest that way.
|
||||||
To run flawfinder, just give it a list of source files or directories to
|
To run flawfinder, just give it a list of source files or directories to
|
||||||
example. For example, to examine all files in "src/" and down recursively:
|
example. For example, to examine all files in "src/" and down recursively:
|
||||||
|
|
||||||
flawfinder src/
|
`flawfinder src/`
|
||||||
|
|
||||||
The manual page (flawfinder.1 or flawfinder.pdf) describes how to use
|
The manual page (flawfinder.1 or flawfinder.pdf) describes how to use
|
||||||
flawfinder (including its various options) and related information
|
flawfinder (including its various options) and related information
|
||||||
(such as how it supports CWE). For example, the "--html" option generates
|
(such as how it supports CWE). For example, the `--html` option generates
|
||||||
output in HTML format. The "--help" option gives a brief list of options.
|
output in HTML format. The `--help` option gives a brief list of options.
|
||||||
|
|
||||||
# Under the hood
|
# Under the hood
|
||||||
|
|
||||||
|
|
|
@ -15,26 +15,24 @@ setup.py
|
||||||
index.html
|
index.html
|
||||||
|
|
||||||
Then run:
|
Then run:
|
||||||
make test && make test-is-correct # update version number in tests
|
`make test && make test-is-correct` # update version number in tests
|
||||||
|
|
||||||
## Test it
|
## Test it
|
||||||
|
|
||||||
make check # Run tests in Python 2 and 3
|
`make check` # Run tests in Python 2 and 3
|
||||||
|
|
||||||
## Tag version
|
## Tag version
|
||||||
|
|
||||||
Once you're sure this is the *real* version, tag it:
|
Once you're sure this is the *real* version, tag it:
|
||||||
|
|
||||||
git tag VERSION
|
`git tag VERSION`
|
||||||
git push
|
`git push`
|
||||||
|
|
||||||
## Create tarball
|
## Create tarball
|
||||||
|
|
||||||
Run:
|
Run:
|
||||||
|
`make distribute`
|
||||||
|
|
||||||
~~~~
|
|
||||||
make distribute
|
|
||||||
~~~~
|
|
||||||
|
|
||||||
## Post tarball
|
## Post tarball
|
||||||
|
|
||||||
|
@ -48,12 +46,8 @@ the usual places:
|
||||||
|
|
||||||
Create a PyPi distribution package:
|
Create a PyPi distribution package:
|
||||||
|
|
||||||
~~~~
|
`make pypi`
|
||||||
make pypi
|
|
||||||
~~~~
|
|
||||||
|
|
||||||
And upload it:
|
And upload it:
|
||||||
|
|
||||||
~~~~
|
`make upload-pypi`
|
||||||
make upload-pypi
|
|
||||||
~~~~
|
|
||||||
|
|
Loading…
Reference in New Issue