Bbroeksema (Talk | contribs) (→XML Migration plan) |
|||
(7 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | |||
− | The [http://www.englishbreakfastnetwork. | + | |
+ | The [http://www.englishbreakfastnetwork.org/ English Breakfast Network (EBN)] is a site dedicated to KDE Quality, including: KDE API Documentation Validation, User Documentation Validation and Source Code Checking. | ||
== Related Links == | == Related Links == | ||
Line 12: | Line 12: | ||
=== APIDOX === | === APIDOX === | ||
=== Doc Sanitizer === | === Doc Sanitizer === | ||
− | == Coverage == | + | === Coverage === |
==Things To-do== | ==Things To-do== | ||
Line 92: | Line 92: | ||
* Switch EBN to XML output. | * Switch EBN to XML output. | ||
* Remove the other output methods from the krazy2 script. | * Remove the other output methods from the krazy2 script. | ||
+ | |||
+ | Next steps would involve storing all results in the db: | ||
+ | |||
+ | * Create new database structure on ebn | ||
+ | * Create xml -> sql stylesheet | ||
+ | * Modify the krazy2xml script to store results in db. | ||
+ | * At some point we might want to migrate the ebn website to a full php website which just queries that db. | ||
+ | |||
+ | == Administration HowTo == | ||
+ | |||
+ | === Finding Component Ids in the DB === | ||
+ | Look at [http://ebn.kde.org/database.php The EBN Administration page] in the Components table area. | ||
+ | |||
+ | === Adding a Component to the DB === | ||
+ | For example, to add component for KDE SC 4.8: | ||
+ | <pre> | ||
+ | % psql -t -h localhost -U kde ebn | ||
+ | ebn=> insert into components values (27,'kde-4.8','KDE SC 4.8',''); | ||
+ | ebn=> \quit | ||
+ | </pre> | ||
+ | Now reload [http://ebn.kde.org/database.php The EBN Administration page] and you will see the new Id listed in the Components table. | ||
+ | |||
+ | === Finding Tool Ids in the DB === | ||
+ | Look at [http://ebn.kde.org/database.php The EBN Administration page] in the Tools table area. | ||
+ | |||
+ | === Adding Tools to the DB === | ||
+ | You need to add each supported tool to the components of interest. So, to add all our favorite tools to the new kde-4.8 component: | ||
+ | <pre> | ||
+ | % psql -t -h localhost -U kde ebn | ||
+ | ebn=> insert into tools values (120,'krazy',27,'Code Checking','','/krazy/',0,'t'); | ||
+ | ebn=> insert into tools values (121,'sanitizer',27,'Documentation Sanitizer','','/sanitizer/',0,'t'); | ||
+ | ebn=> insert into tools values (122,'dox',27,'API Documentation','','/apidox/',0,'t'); | ||
+ | ebn=> \quit | ||
+ | </pre> | ||
+ | Now reload [http://ebn.kde.org/database.php The EBN Administration page] and you will see the new Tools listed in the Tools table. | ||
+ | |||
+ | === Adding a Checkout for a Component === | ||
+ | In the quality repo, edit tools/update-checkouts and add a "source_update" line for the new component. For example, to add 4.8: | ||
+ | <pre> | ||
+ | source_update $TOP/kde-4.8 "$SC_SVN_MODULES" "branches/KDE/4.8" "4.8" | ||
+ | </pre> | ||
+ | Commit the change for update-checkouts. | ||
+ | |||
+ | The next time the EBN machine does a checkout update (done nightly), the new component will be added to the sources available. | ||
+ | |||
+ | Or, you can login to the EBN and manually install and run the update, like so: | ||
+ | <pre> | ||
+ | % cd /srv/sources/quality | ||
+ | % svn up | ||
+ | % cd tools | ||
+ | % ./install.sh | ||
+ | % ~/bin/update-checkouts | ||
+ | </pre> | ||
== People == | == People == |
The English Breakfast Network (EBN) is a site dedicated to KDE Quality, including: KDE API Documentation Validation, User Documentation Validation and Source Code Checking.
Currently bbroeksema is working on xml output for the krazy2 tool. The plan is to slim down krazy2 in such a way that it will only support text output and xml output. The xml output will be transformed, using XSLT style sheets to other outputs like the ebn website html code but also to SQL queries to keep track of historical data.
First work on style sheets can be found at:
http://websvn.kde.org:80/trunk/quality/krazy2/stylesheets/
and to perform the transformations.
Next steps would involve storing all results in the db:
Look at The EBN Administration page in the Components table area.
For example, to add component for KDE SC 4.8:
% psql -t -h localhost -U kde ebn ebn=> insert into components values (27,'kde-4.8','KDE SC 4.8',''); ebn=> \quit
Now reload The EBN Administration page and you will see the new Id listed in the Components table.
Look at The EBN Administration page in the Tools table area.
You need to add each supported tool to the components of interest. So, to add all our favorite tools to the new kde-4.8 component:
% psql -t -h localhost -U kde ebn ebn=> insert into tools values (120,'krazy',27,'Code Checking','','/krazy/',0,'t'); ebn=> insert into tools values (121,'sanitizer',27,'Documentation Sanitizer','','/sanitizer/',0,'t'); ebn=> insert into tools values (122,'dox',27,'API Documentation','','/apidox/',0,'t'); ebn=> \quit
Now reload The EBN Administration page and you will see the new Tools listed in the Tools table.
In the quality repo, edit tools/update-checkouts and add a "source_update" line for the new component. For example, to add 4.8:
source_update $TOP/kde-4.8 "$SC_SVN_MODULES" "branches/KDE/4.8" "4.8"
Commit the change for update-checkouts.
The next time the EBN machine does a checkout update (done nightly), the new component will be added to the sources available.
Or, you can login to the EBN and manually install and run the update, like so:
% cd /srv/sources/quality % svn up % cd tools % ./install.sh % ~/bin/update-checkouts
The EBN is operated by Adriaan de Groot and Allen Winter.
Authors/Maintainers of the individual quality tools can be found on the About page.