summaryrefslogtreecommitdiff
path: root/util/board_status/to-wiki/README
diff options
context:
space:
mode:
Diffstat (limited to 'util/board_status/to-wiki/README')
-rw-r--r--util/board_status/to-wiki/README39
1 files changed, 0 insertions, 39 deletions
diff --git a/util/board_status/to-wiki/README b/util/board_status/to-wiki/README
deleted file mode 100644
index 0a0d591c87..0000000000
--- a/util/board_status/to-wiki/README
+++ /dev/null
@@ -1,39 +0,0 @@
-Scripts to publish board-status data to the wiki
-================================================
-
-These scripts parse the board-status repository (and the coreboot repository as companion)
-to build a meaningful representation of the test coverage stored in board-status.
-
-The server runs these nightly (CET/CEST), so no user interaction with the wiki page is needed.
-
-How to use
-----------
-When modifying the scripts, or when publishing the results elsewhere, you might want to run them
-yourself. You'll need the board-status and the coreboot repository checked out side by side, named
-"board-status" and "coreboot" respectively (in particular without .git suffix).
-
-To emit wiki-text, in the board-status repository's top-level directory, run
-
- $ ../util/board_status/to-wiki/status-to-wiki.sh
-
-The output ends up on stdout, so you'll have to store it yourself, if you need it later.
-
-`push-to-wiki.sh FILENAME TITLE` can be used to push a file into the wiki.
-User credentials are looked up in ~/.wikiaccount, which should look like
-
- USERNAME=user
- USERPASS=password
-
-How it works
-------------
-status-to-wiki collects the reports and sorts them in buckets by report date. These can have
-weekly, monthly and quarterly granularity.
-It then passes these into the towiki script, which reads the data in more details and prints
-them in the output format.
-
-Contributions
--------------
-These scripts are rather bare, and you're welcome to extend them to extract more useful data
-from both repositories, and to present the data in a nicer way.
-A rewrite into another (reasonable) language is fine, too - shell quickly finds its limits
-for this kind of text processing.