diff mbox

[04/13] docs/manual: reference Python and Lua infras from the list of package infrastructures

Message ID 1393167879-16637-5-git-send-email-thomas.petazzoni@free-electrons.com
State Accepted
Headers show

Commit Message

Thomas Petazzoni Feb. 23, 2014, 3:04 p.m. UTC
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
---
 docs/manual/adding-packages-directory.txt | 11 +++++++++++
 1 file changed, 11 insertions(+)

Comments

Yann E. MORIN Feb. 23, 2014, 3:29 p.m. UTC | #1
Thomas, All,

On 2014-02-23 16:04 +0100, Thomas Petazzoni spake thusly:
> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>

> ---
>  docs/manual/adding-packages-directory.txt | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 
> diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
> index 754a145..eff92fa 100644
> --- a/docs/manual/adding-packages-directory.txt
> +++ b/docs/manual/adding-packages-directory.txt
> @@ -323,5 +323,16 @@ different way, using different infrastructures:
>     CMake. We cover them through a xref:cmake-package-tutorial[tutorial]
>     and xref:cmake-package-reference[reference].
>  
> +* *Makefiles for Python modules*: We have a dedicated infrastructure
> +   for Python modules that use either the +distutils+ or the
> +   +setuptools+ mechanism. We cover them through a
> +   xref:python-package-tutorial[tutorial] and
> +   xref:python-package-reference[reference].

I believe english grammar mandates the following:
    [...] a tutorial and a reference.

So, you're missing an 'a' between the 'and' and the 'reference'.

Also, what about the mandatory status of this? For other package
onfrastructures, we say:
    This infrastructure must be used for new packages that rely on [XXX]
    as their build system.

Why don't we add this for Python modules?

> +* *Makefiles for Lua modules*: We have a dedicated infrastructure for
> +   Lua modules available through the LuaRocks web site. We cover them
> +   through a xref:luarocks-package-tutorial[tutorial] and
> +   xref:luarocks-package-reference[reference].

Ditto 'a' and ditto 'mandatory'.

Regards,
Yann E. MORIN.
Thomas Petazzoni Feb. 23, 2014, 3:37 p.m. UTC | #2
Dear Yann E. MORIN,

On Sun, 23 Feb 2014 16:29:57 +0100, Yann E. MORIN wrote:

> > +* *Makefiles for Python modules*: We have a dedicated infrastructure
> > +   for Python modules that use either the +distutils+ or the
> > +   +setuptools+ mechanism. We cover them through a
> > +   xref:python-package-tutorial[tutorial] and
> > +   xref:python-package-reference[reference].
> 
> I believe english grammar mandates the following:
>     [...] a tutorial and a reference.
> 
> So, you're missing an 'a' between the 'and' and the 'reference'.

Ok. I'll see if Peter applies the patch and makes the change himself
before resending 13 patches :-)

> Also, what about the mandatory status of this? For other package
> onfrastructures, we say:
>     This infrastructure must be used for new packages that rely on [XXX]
>     as their build system.
> 
> Why don't we add this for Python modules?

I found it quite redundant, and in fact I believe it is now a bit
useless even for autotools and cmake packages. It used to be useful at
the time we had old-style packages that were not yet converted. But
nowadays, it is quite clear that if the package infrastructure exists
and matches the build system of a given package, then it must be used.

Thanks a lot for the review!

Thomas
diff mbox

Patch

diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
index 754a145..eff92fa 100644
--- a/docs/manual/adding-packages-directory.txt
+++ b/docs/manual/adding-packages-directory.txt
@@ -323,5 +323,16 @@  different way, using different infrastructures:
    CMake. We cover them through a xref:cmake-package-tutorial[tutorial]
    and xref:cmake-package-reference[reference].
 
+* *Makefiles for Python modules*: We have a dedicated infrastructure
+   for Python modules that use either the +distutils+ or the
+   +setuptools+ mechanism. We cover them through a
+   xref:python-package-tutorial[tutorial] and
+   xref:python-package-reference[reference].
+
+* *Makefiles for Lua modules*: We have a dedicated infrastructure for
+   Lua modules available through the LuaRocks web site. We cover them
+   through a xref:luarocks-package-tutorial[tutorial] and
+   xref:luarocks-package-reference[reference].
+
 Further formatting details: see xref:writing-rules-mk[the writing
 rules].