[prev in list] [next in list] [prev in thread] [next in thread] 

List:       php-doc-cvs
Subject:    [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/reference/ffi/ffi/_load.xml?=
From:       Christoph_Michael_Becker <cmb () php ! net>
Date:       2020-02-12 13:09:26
Message-ID: svn-cmb-1581512966-349215-244152600 () svn ! php ! net
[Download RAW message or body]

cmb                                      Wed, 12 Feb 2020 13:09:26 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=349215

Log:
Clarify pseudo C preprocessor support

Based on a patch provided by Larry Garfield.

Changed paths:
    U   phpdoc/en/trunk/reference/ffi/ffi/load.xml

Modified: phpdoc/en/trunk/reference/ffi/ffi/load.xml
===================================================================
--- phpdoc/en/trunk/reference/ffi/ffi/load.xml	2020-02-12 10:06:33 UTC (rev 349214)
+++ phpdoc/en/trunk/reference/ffi/ffi/load.xml	2020-02-12 13:09:26 UTC (rev 349215)
@@ -28,12 +28,23 @@
      <para>
       The name of a C header file.
      </para>
-     <note>
-      <para>
-       C preprocessor directives are not supported, i.e. <code>#include</code>,
-       <code>#define</code> and CPP macros do not work.
-      </para>
-     </note>
+     <para>
+      C preprocessor directives are not supported, i.e. <literal>#include</literal>,
+      <literal>#define</literal> and CPP macros do not work, except for special cases
+      listed below.
+     </para>
+     <para>
+      The header file <emphasis>should</emphasis> contain a <literal>#define</literal> statement for the
+      <literal>FFI_SCOPE</literal> variable, e.g.: <code>#define FFI_SCOPE "MYLIB"</code>.
+      Refer to the <link linkend="ffi.intro">class introduction</link> for details.
+     </para>
+     <para>
+      The header file <emphasis>may</emphasis> contain a <literal>#define</literal> statement for the
+      <literal>FFI_LIB</literal> variable to specify the library it exposes. If it is
+      a system library only the file name is required, e.g.: <code>#define FFI_LIB
+      "libc.so.6"</code>.  If it is a custom library, a relative path is required,
+      e.g.: <code>#define FFI_LIB "./mylib.so"</code>.
+     </para>
     </listitem>
    </varlistentry>
   </variablelist>



-- 
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

[prev in list] [next in list] [prev in thread] [next in thread]