Formatting cleanup ENGINE-237
authorDamiano Boppart <damiano@pep-security.net>
Tue, 29 Aug 2017 00:56:32 +0200
branchENGINE-237
changeset 2015eefffcd9f781
parent 2014 4b6659d17b61
child 2016 88b165732da5
child 2018 479c39e0c729
Formatting cleanup
doc/build-debian.md
doc/build-macos.md
doc/readme.md
     1.1 --- a/doc/build-debian.md	Tue Aug 29 00:25:54 2017 +0200
     1.2 +++ b/doc/build-debian.md	Tue Aug 29 00:56:32 2017 +0200
     1.3 @@ -95,7 +95,7 @@
     1.4  make db
     1.5  ~~~
     1.6  
     1.7 -The unit tests can be run without the engine library being installed, however the `system.db` must be installed:
     1.8 +The unit tests can be run without the engine library being installed, however `system.db` must be installed:
     1.9  
    1.10  ~~~
    1.11  make -C db install
     2.1 --- a/doc/build-macos.md	Tue Aug 29 00:25:54 2017 +0200
     2.2 +++ b/doc/build-macos.md	Tue Aug 29 00:56:32 2017 +0200
     2.3 @@ -26,7 +26,8 @@
     2.4  sudo port install gpgme
     2.5  ~~~
     2.6  
     2.7 -FIXME Are `zlib openssl cyrus-sasl2` needed? They were in an older revision of the instructions
     2.8 +FIXME Are `zlib openssl cyrus-sasl2` needed?
     2.9 +They were present in an older revision of the build instructions.
    2.10  
    2.11  Ensure that `python` is Python 2.7:
    2.12  
    2.13 @@ -109,7 +110,7 @@
    2.14  make db
    2.15  ~~~
    2.16  
    2.17 -The unit tests can be run without the engine library being installed, however the `system.db` must be installed:
    2.18 +The unit tests can be run without the engine library being installed, however `system.db` must be installed:
    2.19  
    2.20  ~~~
    2.21  make -C db install
     3.1 --- a/doc/readme.md	Tue Aug 29 00:25:54 2017 +0200
     3.2 +++ b/doc/readme.md	Tue Aug 29 00:56:32 2017 +0200
     3.3 @@ -32,13 +32,18 @@
     3.4  
     3.5  # The pEp Engine's databases
     3.6  The p≡p Engine uses two databases:
     3.7 -`~/.pEp_management` (on *NIX) or `%LOCALAPPDATA%\pEp\management.db` on Windows, and `/usr/local/share/system.db` (on *NIX) or `%ALLUSERSPROFILE%\pEp\system.db`.
     3.8 -The latter contains the Trustwords databases.
     3.9  
    3.10 -The management db is created by the first call of init() of p≡p Engine.
    3.11 +- the management database
    3.12 +  - `~/.pEp_management` on \*NIX
    3.13 +  - `%LOCALAPPDATA%\pEp\management.db` on Windows
    3.14 +- the Trustword database
    3.15 +  - `/usr/local/share/system.db` on \*NIX
    3.16 +  - `%ALLUSERSPROFILE%\pEp\system.db` on Windows
    3.17 +
    3.18 +The management db is created by the first call of `init()` of p≡p Engine.
    3.19  It does not need to be created manually.
    3.20  `system.db` is created by using the DDL in `db/create_system_db.sql`; the database content is created by `db/dic2csv.py` out of hunspell's dictionary packages (or something similar) and then imported using `sqlite3`'s `.import` command.
    3.21  Dictionary files for different languages are part of the p≡p Engine source distribution.
    3.22  
    3.23  You can test the Trustwords in `system.db` using `db/trustwords.py`.
    3.24 -Both Python tools have a `--help` switch.
    3.25 \ No newline at end of file
    3.26 +Both Python tools have a `--help` switch.