[llvm-branch-commits] [llvm] [LLVM][docs] Finish MyST migration for remaining docs (batch 11) (PR #223100)

[Nick Desaulniers via llvm-branch-commits]

nickdesaulniers wrote:

Good idea, also had a bot chew on this:


> llvm/docs/SecurityTransparencyReports.md (lines 111–161, ## 2023 section):
> around all 26 https://... URLs

My bot counted 28. There are 2 that are immediately followed by a period, so perhaps check for that.

> Single-backtick code identifiers converted to *italics* instead of `code`:

More cases of that:

  1. Lines 593–594 (*m*, *n*, *i*, *j*, *ls*):
  #issuecomment-5733523561 flagged *int* and *list\<int>* on ProgRef.md:593-594, but missed *m*, *n*, *i*, *j*, and *ls* on the same two lines
  (which are already formatted as inline code `m`, `n`, `i`, `j`, `ls` in the immediately preceding list on lines 587–590):
    --- a/llvm/docs/TableGen/ProgRef.md
    +++ b/llvm/docs/TableGen/ProgRef.md
    @@ -593,2 +593,2 @@
    -The type of *m* and *n* should be *int*.
    -The type of *i*, *j*, and *ls* should be either *int* or *list\<int>*.
    +The type of `m` and `n` should be `int`.
    +The type of `i`, `j`, and `ls` should be either `int` or `list<int>`.

  2. Line 554 (*Type*):
  In ProgRef.md:554, *Type* refers to the grammar production Type from the !isa<Type> / bang-operator syntax block right above it (and line 555
  uses `Type` in backticks):
    --- a/llvm/docs/TableGen/ProgRef.md
    +++ b/llvm/docs/TableGen/ProgRef.md
    @@ -554,2 +554,2 @@
    -The *Type* is only accepted for certain bang operators, and must not be
    -specified with other bang operators. When `Type` is omitted, the curly braces
    +The `Type` is only accepted for certain bang operators, and must not be
    +specified with other bang operators. When `Type` is omitted, the curly braces

  3. Lines 298 & 429 (bits<n>):
  In ProgRef.md:298 and ProgRef.md:429, ``bits<`` `n` ``>`` was converted to `bits<`*n*`>` (adjacent inline code spans sandwiching italics).
  While valid CommonMark, it renders with mixed <code class="docutils literal">bits<</code><em>n</em><code class="docutils literal">></code>
  styling.
---
One indented syntax line at ProgRef.md:1525 is still a > blockquote instead of a code block or unindented syntax line:

    --- a/llvm/docs/TableGen/ProgRef.md
    +++ b/llvm/docs/TableGen/ProgRef.md
    @@ -1523,3 +1523,3 @@
     The syntax of a `dag` instance is:
     
    -> `(` *operator* *argument1*`,` *argument2*`,` ... `)`
    +`(` *operator* *argument1*`,` *argument2*`,` ... `)`


https://github.com/llvm/llvm-project/pull/223100