diff options
| author | Mehdi Amini <mehdi.amini@apple.com> | 2016-07-18 21:29:24 +0000 |
|---|---|---|
| committer | Mehdi Amini <mehdi.amini@apple.com> | 2016-07-18 21:29:24 +0000 |
| commit | 4d74631ea428236a66906fd34abd3590943b2bdc (patch) | |
| tree | d69da37a23fdd4f242a791d101f9b10bb6211d64 | |
| parent | 2124157102577f323b7d3cec949bc9a854faab1f (diff) | |
| download | bcm5719-llvm-4d74631ea428236a66906fd34abd3590943b2bdc.tar.gz bcm5719-llvm-4d74631ea428236a66906fd34abd3590943b2bdc.zip | |
Update doxygen description for `WriteBitcodeToFile()` API (NFC)
llvm-svn: 275917
| -rw-r--r-- | llvm/include/llvm/Bitcode/ReaderWriter.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/llvm/include/llvm/Bitcode/ReaderWriter.h b/llvm/include/llvm/Bitcode/ReaderWriter.h index 76a60a0b8d2..53deaae53c5 100644 --- a/llvm/include/llvm/Bitcode/ReaderWriter.h +++ b/llvm/include/llvm/Bitcode/ReaderWriter.h @@ -94,8 +94,11 @@ namespace llvm { /// Value in \c M. These will be reconstructed exactly when \a M is /// deserialized. /// - /// If \c EmitSummaryIndex, emit the module's summary index (currently - /// for use in ThinLTO optimization). + /// If \c Index is supplied, the bitcode will contain the summary index + /// (currently for use in ThinLTO optimization). + /// + /// \p GenerateHash enables hashing the Module and including the hash in the + /// bitcode (currently for use in ThinLTO incremental build). void WriteBitcodeToFile(const Module *M, raw_ostream &Out, bool ShouldPreserveUseListOrder = false, const ModuleSummaryIndex *Index = nullptr, |
