[PATCH 3/7] python/qemu: add README.rst

John Snow posted 7 patches 5 years, 8 months ago
Maintainers: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>, Cleber Rosa <crosa@redhat.com>, Max Reitz <mreitz@redhat.com>, Eduardo Habkost <ehabkost@redhat.com>, Markus Armbruster <armbru@redhat.com>, Kevin Wolf <kwolf@redhat.com>, "Alex Bennée" <alex.bennee@linaro.org>, "Philippe Mathieu-Daudé" <philmd@redhat.com>, Fam Zheng <fam@euphon.net>
There is a newer version of this series
[PATCH 3/7] python/qemu: add README.rst
Posted by John Snow 5 years, 8 months ago
Add a short readme that explains the package hierarchy, which will be
visible while browsing the source on e.g. gitlab/github.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 python/qemu/README.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
 create mode 100644 python/qemu/README.rst

diff --git a/python/qemu/README.rst b/python/qemu/README.rst
new file mode 100644
index 00000000000..96447b90616
--- /dev/null
+++ b/python/qemu/README.rst
@@ -0,0 +1,8 @@
+python/qemu/
+------------
+
+This directory serves as the root of a `Python PEP 420 implicit
+namespace package <<https://www.python.org/dev/peps/pep-0420/>`_.
+
+Each directory below is assumed to be an installable Python module that
+will be available under the ``qemu.<module>`` namespace.
-- 
2.21.3


Re: [PATCH 3/7] python/qemu: add README.rst
Posted by Vladimir Sementsov-Ogievskiy 5 years, 8 months ago
03.06.2020 03:15, John Snow wrote:
> Add a short readme that explains the package hierarchy, which will be
> visible while browsing the source on e.g. gitlab/github.
> 
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>   python/qemu/README.rst | 8 ++++++++
>   1 file changed, 8 insertions(+)
>   create mode 100644 python/qemu/README.rst
> 
> diff --git a/python/qemu/README.rst b/python/qemu/README.rst
> new file mode 100644
> index 00000000000..96447b90616
> --- /dev/null
> +++ b/python/qemu/README.rst
> @@ -0,0 +1,8 @@
> +python/qemu/
> +------------
> +
> +This directory serves as the root of a `Python PEP 420 implicit
> +namespace package <<https://www.python.org/dev/peps/pep-0420/>`_.
> +
> +Each directory below is assumed to be an installable Python module that

As far as I understand terminology: s/module/package/

> +will be available under the ``qemu.<module>`` namespace.
> 

and here.

Possibly I'm wrong. anyway:
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>

-- 
Best regards,
Vladimir

Re: [PATCH 3/7] python/qemu: add README.rst
Posted by John Snow 5 years, 8 months ago

On 6/5/20 10:56 AM, Vladimir Sementsov-Ogievskiy wrote:
> 03.06.2020 03:15, John Snow wrote:
>> Add a short readme that explains the package hierarchy, which will be
>> visible while browsing the source on e.g. gitlab/github.
>>
>> Signed-off-by: John Snow <jsnow@redhat.com>
>> ---
>>   python/qemu/README.rst | 8 ++++++++
>>   1 file changed, 8 insertions(+)
>>   create mode 100644 python/qemu/README.rst
>>
>> diff --git a/python/qemu/README.rst b/python/qemu/README.rst
>> new file mode 100644
>> index 00000000000..96447b90616
>> --- /dev/null
>> +++ b/python/qemu/README.rst
>> @@ -0,0 +1,8 @@
>> +python/qemu/
>> +------------
>> +
>> +This directory serves as the root of a `Python PEP 420 implicit
>> +namespace package <<https://www.python.org/dev/peps/pep-0420/>`_.
>> +
>> +Each directory below is assumed to be an installable Python module that
> 
> As far as I understand terminology: s/module/package/
> 
>> +will be available under the ``qemu.<module>`` namespace.
>>
> 
> and here.
> 
> Possibly I'm wrong. anyway:
> Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
> 

Oh, you're right. Each file is a module, each folder is a package. Thank
you for spotting that.