)]}'
{
  "commit": "3cb23f1ff54e5ee37b761fdcbb832f69ee956d55",
  "tree": "d5f0734eccb0ff771e2361276eb2872a9fa4b1d1",
  "parents": [
    "d7be11ef70788b8f50232b5568088903077c5fae"
  ],
  "author": {
    "name": "G. Branden Robinson",
    "email": "Branden.Robinson@data61.csiro.au",
    "time": "Thu Oct 10 14:33:46 2019 +1100"
  },
  "committer": {
    "name": "G. Branden Robinson",
    "email": "Branden.Robinson@data61.csiro.au",
    "time": "Tue Nov 05 12:35:30 2019 +1100"
  },
  "message": "sel4bench.h: update documentation and style\n\n* Expand documentation of `sel4bench_enable_counters()`.\n* Document `sel4bench_get_num_counter_chunks()`.\n* Add missing @param and @return notations.\n* Consistently use plurals in the strings for generic event names.\n* Use Markdown backticks for literals (e.g., symbol names).\n* Keep @param and @return descriptions terse (they should be noun\n  phrases appropriate for tool tips).  Elaborations go in the function\n  description.\n* Don\u0027t abbreviate `sel4bench_init()` and `sel4bench_destroy()` as\n  `_init()` and `_destroy()`, respectively.  Use the full names.\n* Move documentation of constraint on number of counters to\n  `sel4bench_get_num_counters()`, instead of duplicating it in two other\n  functions.\n* Emphasise that the cycle counter is not a performance counter.\n* Clarify reference to ARM1136 platform, a.k.a. \"kzm\".\n\nFlag open questions:\n* Should some of these prototypes and constant objects be moved to a\n  \"private\" header file?\n\nMinor style issues:\n* Perform minor wordsmithing.\n* Use hyphens more idiomatically.\n* Wrap lines at 80 columns.\n* Use two spaces between sentences for readability.\n",
  "tree_diff": [
    {
      "type": "modify",
      "old_id": "7c8e02d62cc04b734e9ab720c27950257684b0c5",
      "old_mode": 33188,
      "old_path": "libsel4bench/include/sel4bench/sel4bench.h",
      "new_id": "f6eac71d77d753d196f1e9642dad83c33a9d2648",
      "new_mode": 33188,
      "new_path": "libsel4bench/include/sel4bench/sel4bench.h"
    }
  ]
}