r272215 - [docs] Coverage: Clarify return value of __llvm_profile_write_file

[Vedant Kumar via cfe-commits]

Author: vedantk
Date: Wed Jun  8 17:32:03 2016
New Revision: 272215

URL: http://llvm.org/viewvc/llvm-project?rev=272215&view=rev
Log:
[docs] Coverage: Clarify return value of __llvm_profile_write_file

Modified:
    cfe/trunk/docs/SourceBasedCodeCoverage.rst

Modified: cfe/trunk/docs/SourceBasedCodeCoverage.rst
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/SourceBasedCodeCoverage.rst?rev=272215&r1=272214&r2=272215&view=diff
==============================================================================
--- cfe/trunk/docs/SourceBasedCodeCoverage.rst (original)
+++ cfe/trunk/docs/SourceBasedCodeCoverage.rst Wed Jun  8 17:32:03 2016
@@ -206,8 +206,9 @@ without using static initializers, do th
   to ``__llvm_profile_write_file``.
 
 * Forward-declare ``int __llvm_profile_write_file(void)`` and call it to write
-  out a profile. Calling this function multiple times appends profile data to
-  an existing on-disk raw profile.
+  out a profile. This function returns 0 when it succeeds, and a non-zero value
+  otherwise. Calling this function multiple times appends profile data to an
+  existing on-disk raw profile.
 
 Drawbacks and limitations
 =========================