[Reproducible-commits] [blog] 02/02: Make it clearer this API is preliminary

[Ceridwen]

This is an automated email from the git hooks/post-receive script.

ceridwen-guest pushed a commit to branch master
in repository blog.

commit eb664b1c5ff9b34e3504ec8e5ffd04f115255944
Author: Ceridwen <ceridwenv at gmail.com>
Date:   Tue Jun 7 23:18:12 2016 -0400

    Make it clearer this API is preliminary
---
 drafts/people/ceridwen/reprotest_week2.mdwn | 95 +++++++++++------------------
 1 file changed, 36 insertions(+), 59 deletions(-)

diff --git a/drafts/people/ceridwen/reprotest_week2.mdwn b/drafts/people/ceridwen/reprotest_week2.mdwn
index b2814d8..5d47c48 100644
--- a/drafts/people/ceridwen/reprotest_week2.mdwn
+++ b/drafts/people/ceridwen/reprotest_week2.mdwn
@@ -1,77 +1,54 @@
-[[!meta title="Reprotest has a basic CLI and basic configuration file handling"]]
+[[!meta title="Reprotest has a preliminary CLI and configuration file handling"]]
 [[!meta date="Mon Jun  6 15:08:30 2016 +0000"]]
 [[!tag reproducible_builds Debian reprotest Outreachy]]
 Author: ceridwen
 
-Reprotest's CLI takes two mandatory arguments, the build command to
-run and the build artifact file to test after running the build.  If
-the build command or build artifact have spaces, they have to be
-passed as strings, e.g. "debuild -b -uc -us."  For optional arguments,
-it has --variations, which accepts a list of possible build variations
-to test, one or more of 'captures_environment', 'cpu', 'domain',
-'filesystem', 'group', 'home', 'host', 'kernel', 'locales',
-'namespace', 'path', 'shell', 'time', 'timezone', 'umask', and 'user'
+This is the first draft of reprotest's interface, and I welcome
+comments on how to improve it.  At the moment, reprotest's CLI takes
+two mandatory arguments, the build command to run and the build
+artifact file to test after running the build.  If the build command
+or build artifact have spaces, they have to be passed as strings,
+e.g. `"debuild -b -uc -us"`.  For optional arguments, it has
+`--variations`, which accepts a list of possible build variations to
+test, one or more of 'captures_environment', 'domain_host',
+'filesystem', 'home', 'kernel', 'locales',
+'path', 'shell', 'time', 'timezone', 'umask', and 'user_group'
 (see
 [variations](https://tests.reproducible-builds.org/index_variations.html)
-for more information); --dont_vary, which makes reprotest *not* test
-any variations in its list (the default is to run all variations);
---source_root, which accepts a directory to run the build command in
+for more information); `--dont_vary`, which makes reprotest *not* test
+any variations in the given list (the default is to run all variations);
+`--source_root`, which accepts a directory to run the build command in
 and defaults to the current working directory; and --verbose, which
 will eventually enable more detailed logging.  To get help for the
-CLI, run reprotest -h or reprotest --help.
+CLI, run `reprotest -h` or `reprotest --help`.
 
 The config file has one section, basics, and the same options as the
-CLI, except there's no dont_vary option, and there are build_command
-and artifact options.  If build_command and/or artifact are set in the
-config file, reprotest can be run without passing those as
+CLI, except there's no dont_vary option, and there are `build_command`
+and `artifact` options.  If `build_command` and/or `artifact` are set
+in the config file, reprotest can be run without passing those as
 command-line arguments.  Command-line arguments always override config
 file options.  Reprotest currently searches the working directory for
 the config file, but it will also eventually search the user's home
 directory.  A sample config file is below.
 
-```
-[basics]
-
-build_command = setup.py build
-
-artifact = build/
-
-source_root = reprotest/
-
-variations =
-
-  captures_environment
-
-  cpu
-
-  domain
-
-  filesystem
-
-  group
-
-  home
-
-  host
-
-  kernel
-
-  locales
-
-  namespace
-
-  path
-
-  shell
-
-  time
-
-  timezone
-
-  umask
-
-  user
-```
+    [basics]
+    build_command = setup.py sdist
+    artifact = dist/reprotest-0.1.tar.gz
+    source_root = reprotest/
+    variations =
+      captures_environment
+      domain_host
+      filesystem
+      home
+      host
+      kernel
+      locales
+      path
+      shell
+      time
+      timezone
+      umask
+      user_group
 
 At the moment, the only build variations that reprotest actually tests
 are the environment variable variations: captures_environment, home,

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/blog.git