documentation: fix a typo in Quickstart #50
Conversation
|
I created this issue before I decided to fix the code and ask for a pull: |
|
Thank you for the PR. A changelog update and version bump is needed to merge this. There seems to be residual mentions of |
|
Hi Pawan, I am reading the documentation further and will combine all the fixes into a single merge request with an updated CHANGELOG at the end. It will probably take me a week (I am trying to run tests on my CPU at the same time). |
…ing fixed width fornt for CLI options, use '--' prefix for options, clean up of sentance capitalization and punctuation.
jeras
force-pushed
the
master
branch
3 times, most recently
from
eea0e76 to
5189ce1
Compare
…hanges done to the entire documentation by search and manual replace
| 2. The database checks for macro sanity - i.e. certain macros exists and in the correct order. | ||
| 3. Each time a new test is added to the ``suite`` directory, the database utility has to be run manually and the database.yaml | ||
| 3. Each time a new test is added to the ``suite`` directory, the database utility has to be run manually and the ``database.yaml`` |
There was a problem hiding this comment.
This particular entry in the notes can be removed as the database is generated every time for each riscof run. It can probably be modified to:
3. The database file is generated by default every time for any relevant command unless a ``--database`` argument is supplied in the command.
4. Each time a new test is added to the ``suite`` directory, the database utility has to be run to ensure that the test is included in the ``database.yaml``. This can be done by running the `gendb` command or by skipping the ``--database`` argument in the CLI for relevant commands.
There was a problem hiding this comment.
I will have a look at it this weekend.
Otherwise I still have some documentation files to go through, before the changes would be ready for a merge.
I have split the changes into multiple commits, so they are easier to review.
Every find/replace (for capitalization) has its own commit, and I will try to split remaining changes into:
- fixed width font,
- spelling and grammar,
- functionality.
I did not make changes to the Python source code, although there are many cases with missing capitalization.
Consequentially I also did not make changes to code blocks in the documentation.
I fixed a typo in a CLI and added a cosmetic update to a sentance.