Document the -gen-inline option.
authorReid Spencer <rspencer@reidspencer.com>
Thu, 1 Jun 2006 23:46:30 +0000 (23:46 +0000)
committerReid Spencer <rspencer@reidspencer.com>
Thu, 1 Jun 2006 23:46:30 +0000 (23:46 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@28646 91177308-0d34-0410-b5e6-96231b3b80d8

docs/CommandGuide/llvm2cpp.pod

index 9d8059da404b394dd00fa1be3a7fe4ac13ebdd0d..ecdf7983607d61f637422a1b71673b949ea87b59 100644 (file)
@@ -137,6 +137,17 @@ The value of the option must be the name of a function in the input module for
 which code should be generated. If the named function does not exist an error
 will be produced.
 
+=item B<-gen-inline>
+
+This option is very analagous to B<-gen-function> except that the generated
+function will not re-produce the target function's definition. Instead, the body
+of the target function is inserted into some other function passed as an
+argument to the generated function. Similarly any arguments to the function must
+be passed to the generated function. The result of the generated function is the
+first basic block of the target function.
+
+The B<-for> option works the same way as it does for B<-gen-function>.
+
 =item B<-gen-variable>
 
 Specify that the output should be a function that produces the definitions