[Buildroot] [PATCH] docs/manual: add "python-package CFFI backend" section

[Buildroot] [PATCH] docs/manual: add "python-package CFFI backend" section

[yegorslists at googlemail.com]

From: Yegor Yefremov <yegorslists@googlemail.com>

Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>
---
 docs/manual/adding-packages-python.txt | 36 ++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/docs/manual/adding-packages-python.txt b/docs/manual/adding-packages-python.txt
index 588dbf8..3278998 100644
--- a/docs/manual/adding-packages-python.txt
+++ b/docs/manual/adding-packages-python.txt
@@ -160,3 +160,39 @@ possible to customize what is done in any particular step:
   +PYTHON_FOO_BUILD_CMDS+ variable, it will be used instead of the
   default Python one. However, using this method should be restricted
   to very specific cases. Do not use it in the general case.
+
+[[python-package-cffi-backend]]
+
+==== +python-package+ CFFI backend
+
+C Foreign Function Interface for Python (CFFI) provides a convenient and
+reliable way to call compiled C code from Python using interface declarations
+written in C. Python packages relying on this backend can be identified by
+appearance of +cffi+ dependency in an +install_requires+ field of their
++setup.py+ file.
+
+Such a package needs +python-cffi+ as a runtime dependency in order to import
+compiled C library wrapper on a target and +host-python-cffi+ as a build-time
+dependency in order to cross-compile the C wrapper. You'll need to add following
+code to you package's +Config.in+ and +*.mk+ files respectively:
+
+
+------------------------
+config BR2_PACKAGE_PYTHON_FOO
+        bool "python-foo"
+        select BR2_PACKAGE_PYTHON_CFFI # runtime
+------------------------
+
+------------------------
+################################################################################
+#
+# python-foo
+#
+################################################################################
+
+...
+
+PYTHON_FOO_DEPENDENCIES = host-python-cffi
+
+$(eval $(python-package))
+------------------------
-- 
2.7.0

[Buildroot] [PATCH] docs/manual: add "python-package CFFI backend" section

[Arnout Vandecappelle]

On 02/22/16 10:20, yegorslists at googlemail.com wrote:
> From: Yegor Yefremov <yegorslists@googlemail.com>
> 
> Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>

 Hi Yegor,

 A few forgotton words as indicated below.

 Also, Peter, have you given some thought to my proposal of requiring the
http://dustycloud.org/blog/vcs-friendly-patchable-document-line-wrapping/
line wrapping style for new documentation patches?

> ---
>  docs/manual/adding-packages-python.txt | 36 ++++++++++++++++++++++++++++++++++
>  1 file changed, 36 insertions(+)
> 
> diff --git a/docs/manual/adding-packages-python.txt b/docs/manual/adding-packages-python.txt
> index 588dbf8..3278998 100644
> --- a/docs/manual/adding-packages-python.txt
> +++ b/docs/manual/adding-packages-python.txt
> @@ -160,3 +160,39 @@ possible to customize what is done in any particular step:
>    +PYTHON_FOO_BUILD_CMDS+ variable, it will be used instead of the
>    default Python one. However, using this method should be restricted
>    to very specific cases. Do not use it in the general case.
> +
> +[[python-package-cffi-backend]]
> +
> +==== +python-package+ CFFI backend
> +
> +C Foreign Function Interface for Python (CFFI) provides a convenient and
> +reliable way to call compiled C code from Python using interface declarations
> +written in C. Python packages relying on this backend can be identified by
> +appearance of +cffi+ dependency in an +install_requires+ field of their

appearance of the +cffi+ dependency

> ++setup.py+ file.
> +
> +Such a package needs +python-cffi+ as a runtime dependency in order to import
> +compiled C library wrapper on a target and +host-python-cffi+ as a build-time

the compiled C library wrapper on the target, and +host-python-cffi+ as a ...

> +dependency in order to cross-compile the C wrapper. You'll need to add following

You'll need to add the following code

> +code to you package's +Config.in+ and +*.mk+ files respectively:

to the package's +Config.in+ and +*.mk+ files, respectively.


 Regards,
 Arnout

> +
> +
> +------------------------
> +config BR2_PACKAGE_PYTHON_FOO
> +        bool "python-foo"
> +        select BR2_PACKAGE_PYTHON_CFFI # runtime
> +------------------------
> +
> +------------------------
> +################################################################################
> +#
> +# python-foo
> +#
> +################################################################################
> +
> +...
> +
> +PYTHON_FOO_DEPENDENCIES = host-python-cffi
> +
> +$(eval $(python-package))
> +------------------------
> 


-- 
Arnout Vandecappelle                          arnout at mind be
Senior Embedded Software Architect            +32-16-286500
Essensium/Mind                                http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium           BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint:  7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF

[Buildroot] [PATCH] docs/manual: add "python-package CFFI backend" section

[Yegor Yefremov]

Hi Arnout,

On Tue, Feb 23, 2016 at 9:07 PM, Arnout Vandecappelle <arnout@mind.be> wrote:
> On 02/22/16 10:20, yegorslists at googlemail.com wrote:
>> From: Yegor Yefremov <yegorslists@googlemail.com>
>>
>> Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>
>
>  Hi Yegor,
>
>  A few forgotton words as indicated below.
>
>  Also, Peter, have you given some thought to my proposal of requiring the
> http://dustycloud.org/blog/vcs-friendly-patchable-document-line-wrapping/
> line wrapping style for new documentation patches?
>
>> ---
>>  docs/manual/adding-packages-python.txt | 36 ++++++++++++++++++++++++++++++++++
>>  1 file changed, 36 insertions(+)
>>
>> diff --git a/docs/manual/adding-packages-python.txt b/docs/manual/adding-packages-python.txt
>> index 588dbf8..3278998 100644
>> --- a/docs/manual/adding-packages-python.txt
>> +++ b/docs/manual/adding-packages-python.txt
>> @@ -160,3 +160,39 @@ possible to customize what is done in any particular step:
>>    +PYTHON_FOO_BUILD_CMDS+ variable, it will be used instead of the
>>    default Python one. However, using this method should be restricted
>>    to very specific cases. Do not use it in the general case.
>> +
>> +[[python-package-cffi-backend]]
>> +
>> +==== +python-package+ CFFI backend
>> +
>> +C Foreign Function Interface for Python (CFFI) provides a convenient and
>> +reliable way to call compiled C code from Python using interface declarations
>> +written in C. Python packages relying on this backend can be identified by
>> +appearance of +cffi+ dependency in an +install_requires+ field of their
>
> appearance of the +cffi+ dependency
>
>> ++setup.py+ file.
>> +
>> +Such a package needs +python-cffi+ as a runtime dependency in order to import
>> +compiled C library wrapper on a target and +host-python-cffi+ as a build-time
>
> the compiled C library wrapper on the target, and +host-python-cffi+ as a ...
>
>> +dependency in order to cross-compile the C wrapper. You'll need to add following
>
> You'll need to add the following code
>
>> +code to you package's +Config.in+ and +*.mk+ files respectively:
>
> to the package's +Config.in+ and +*.mk+ files, respectively.
>
>
>  Regards,
>  Arnout
>
>> +
>> +
>> +------------------------
>> +config BR2_PACKAGE_PYTHON_FOO
>> +        bool "python-foo"
>> +        select BR2_PACKAGE_PYTHON_CFFI # runtime
>> +------------------------
>> +
>> +------------------------
>> +################################################################################
>> +#
>> +# python-foo
>> +#
>> +################################################################################
>> +
>> +...
>> +
>> +PYTHON_FOO_DEPENDENCIES = host-python-cffi
>> +
>> +$(eval $(python-package))
>> +------------------------
>>

Thanks for review. Have sent v2 with applied fixes.

Yegor