Skip to content

Commit

Permalink
Document source_filename in LangRef.
Browse files Browse the repository at this point in the history
Summary: Add documentation for new LLVM IR source_filename identifier.

Reviewers: joker.eph, majnemer

Subscribers: llvm-commits

Differential Revision: http://reviews.llvm.org/D18857

llvm-svn: 267150
  • Loading branch information
teresajohnson committed Apr 22, 2016
1 parent e263b09 commit de9b8b4
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions llvm/docs/LangRef.rst
Expand Up @@ -2196,6 +2196,26 @@ function's scope.
uselistorder i32 (i32) @bar, { 1, 0 }
uselistorder_bb @foo, %bb, { 5, 1, 3, 2, 0, 4 }

.. _source_filename:

Source Filename
---------------

The *source filename* string is set to the original module identifier,
which will be the name of the compiled source file when compiling from
source through the clang front end, for example. It is then preserved through
the IR and bitcode.

This is currently necessary to generate a consistent unique global
identifier for local functions used in profile data, which prepends the
source file name to the local function name.

The syntax for the source file name is simply:

.. code-block:: llvm
source_filename = "/path/to/source.c"
.. _typesystem:

Type System
Expand Down

0 comments on commit de9b8b4

Please sign in to comment.