)]}'
{
  "commit": "44cc4d93e954cc552080ec4e306ada57e490894a",
  "tree": "8b5141cf4e1a90987ce88c68963e888cbb0d6710",
  "parents": [
    "2e191814f163ee1e77e2d6094eee4dd78a289c5b"
  ],
  "author": {
    "name": "Travis Cross",
    "email": "tc@traviscross.com",
    "time": "Sun Jul 28 00:09:57 2024 +0000"
  },
  "committer": {
    "name": "Travis Cross",
    "email": "tc@traviscross.com",
    "time": "Tue Aug 06 06:12:29 2024 +0000"
  },
  "message": "Reformat (and only reformat) the inline assembly chapter\n\nThe go forward plan adopted by T-spec on 2024-06-13 includes, as one\nstep, to reformat all of the chapters of the Reference to attach named\nidentifiers to each claim, more or less.  The resulting text will use\nthe `mdbook-spec` extension for rendering (see PR #1542).\n\nAdding these named identifiers more granularly throughout the document\nis one step in allowing the Reference to be used as a specification\nfor Rust in safety-critical applications.\n\nPer our plan, we want to reformat one chapter first, to ensure our\nhappiness with that and to perfect our process, and to then\nreformat (and review and merge those reformattings of) all of the rest\nof the Reference chapters in the same way.  We discussed and imagined\nthat this reformatting would be somewhat mechanical, and that it could\nbe done by a technical writer with limited experience with Rust.  This\nis what gave us confidence that this work could be hired out,\ncompleted, and reviewed on the months-scale timeline that we had set\nout.\n\nAs a demonstration of the first step in that plan, this PR\nperforms *only* reformatting.  That is, we add identifiers to each\nclaim, more or less, *and nothing else*.  We change *none* of the\nverbiage in this chapter.\n\nOur finding is that doing things this way works out fine.  The\noriginal text was already organized reasonably well enough to just\nleave it in place and add the identifiers.\n\nThere\u0027s always more that could be done to improve a chapter.  E.g.,\nperhaps some claims could be broken down further still and more\nidentifiers added, though there is a distinct readability tradeoff\nhere.  We\u0027ve tried to strike a reasonable balance in this PR.\n\nThe point of the exercise contained in this PR is that this diff is\nstraightforward to review and moves us in the direction that we want\nto go.  We can always make other changes later, and by separating them\nout, those changes will be easier to review also.\n\nNote that we\u0027re unhappy with the current rendering when two\nidentifiers need to be stacked, e.g.:\n\n```\n[asm]\n[asm.intro]\n```\n\nWe\u0027ll plan to improve this later and separately with work in\n`mdbook-spec` or in the style sheets.\n",
  "tree_diff": [
    {
      "type": "modify",
      "old_id": "56e170bb5702a54847c0957f6a442a33ea90c49c",
      "old_mode": 33188,
      "old_path": "src/inline-assembly.md",
      "new_id": "1167fa3686f5345775bef2c108cb58308ca4d098",
      "new_mode": 33188,
      "new_path": "src/inline-assembly.md"
    }
  ]
}