[PATCH] D117067: [Bitcode] Mention that a multi-module bitcode is valid, each module has exactly one MODULE_BLOCK block

[Mingming Liu via Phabricator via llvm-commits]

luna updated this revision to Diff 401057.
luna retitled this revision from "[Bitcode] Call takeError if MaybeVBR doesn't have a value, and update bitcode doc on module block" to "[Bitcode] Mention that a multi-module bitcode is valid, each module has exactly one MODULE_BLOCK block".
luna removed a reviewer: jfb.
luna added a subscriber: jfb.
luna added a comment.

Keep the documentation change and put bitcode reader change to https://reviews.llvm.org/D117630 (which is still a draft).


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D117067/new/

https://reviews.llvm.org/D117067

Files:
  llvm/docs/BitCodeFormat.rst


Index: llvm/docs/BitCodeFormat.rst
===================================================================
--- llvm/docs/BitCodeFormat.rst
+++ llvm/docs/BitCodeFormat.rst
@@ -557,9 +557,10 @@
 ---------------------
 
 The ``MODULE_BLOCK`` block (id 8) is the top-level block for LLVM bitcode files,
-and each bitcode file must contain exactly one. In addition to records
-(described below) containing information about the module, a ``MODULE_BLOCK``
-block may contain the following sub-blocks:
+and each module in a bitcode file must contain exactly one. A bitcode file with
+multi-module bitcode is valid. In addition to records (described below)
+containing information about the module, a ``MODULE_BLOCK`` block may contain
+the following sub-blocks:
 
 * `BLOCKINFO`_
 * `PARAMATTR_BLOCK`_


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D117067.401057.patch
Type: text/x-patch
Size: 791 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20220119/f5414aa2/attachment.bin>