aboutsummaryrefslogtreecommitdiff
path: root/llvm/lib/CodeGen/MachineOperand.cpp
diff options
context:
space:
mode:
authorBrian Gesiak <modocache@gmail.com>2018-01-15 21:23:32 +0000
committerBrian Gesiak <modocache@gmail.com>2018-01-15 21:23:32 +0000
commit17dfa193a50d83904248d1677d2457f99f03d7ce (patch)
treeca19b9a38d242d4f702b5d4e4e20db80d8e347f8 /llvm/lib/CodeGen/MachineOperand.cpp
parent0d0cec879b56f15a7dbd78fe0d026e762137bb92 (diff)
downloadllvm-17dfa193a50d83904248d1677d2457f99f03d7ce.zip
llvm-17dfa193a50d83904248d1677d2457f99f03d7ce.tar.gz
llvm-17dfa193a50d83904248d1677d2457f99f03d7ce.tar.bz2
[docs] Only LLVM IR bitstreams begin with 'BC'
Summary: The LLVM Bitcode File Format documentation states that all bitstreams begin with the magic number 'BC', and that generic bitstream analyzer tools may check for this number in order to determine whether the stream is a bitstream. However, in practice: * Only LLVM IR bitcode begins with 'BC'. Other bitstreams -- Clang AST files and precompiled headers, Clang serialized diagnostics, Swift modules -- do not start with 'BC'. A tool that actually checked for 'BC' would only be able to recognize LLVM IR. * The `llvm-bcanalyzer`, arguably the most used generic bitstream analyzer tool, does not check for a magic number 'BC' (except to determine whether the file is LLVM IR). Update the bitcode format documentation to make it clear that not all bitstreams begin with 'BC', and that tools should not rely on that particular magic number value. Test Plan: Build the `docs-llvm-html` target and confirm the changes render in a Safari web browser. Reviewers: harlanhaskins, eugenis, mehdi_amini, pcc, angerman Reviewed By: angerman Subscribers: angerman, llvm-commits Differential Revision: https://reviews.llvm.org/D42002 llvm-svn: 322520
Diffstat (limited to 'llvm/lib/CodeGen/MachineOperand.cpp')
0 files changed, 0 insertions, 0 deletions