Python Documentation and AIX specifics - how to proceed?
First - best wishes all for a happy and healthy 2020! As my nickname implies - my primary means to contribute to Python is with regard to AIX. One of the things I recently came across is Misc/README.AIX which was last updated sometime between 2010 and 2014. I am thinking a facelift is in order. Assuming 2010-2011 as the original date - much has changed and many of the comments are no longer accurate. Before saying so, I would like to check here that - having all tests pass on the 3.8 bot implies that there are no outstanding issues. As to the historical issues in the current document - these could either be deleted, or a short text describing when they were resolved (e.g., Python 3.7, or just resolved, but noone knows exactly how or when - whether it was a Python change, or a platform (AIX) change. What I see as being more relevant is the description re: how to build Python for AIX - for the "do it youself"-ers. So, besides the direct question re: what to say about the old "known issues" and whether there are no known issues aka, no issues identified via the standard tests - I would appreciate feedback on what is considered appropriate - anno 2020 - for any Misc/README.platform text. Additionally, I am willing to work on other areas of the standard documentation where it is either needed or considered appropriate for platform specific details and/or examples. This is not something I would try to get done in a single PR, Instead I am thinking a single -longer term- issue - and multiple PR's to work through corrections and additions during 2020. Focus on Python 3.9 and beyond yet where appropriate backlevel to Python 3.8 or even 3.7. Sincerely, Michael
That whole directory is mostly outdated (e.g. those Wing files are two major versions behind and we have ripped out all other editor-specific files in the repo). I think the first question is what do we want for that directory to be? Based on that we can decide if something like AIX build instructions makes sense or if we should just gut the directory. For me personally, I'm torn. While helping out other folks using AIX through that text file might be good due to the work you put in, Michael, while not being an officially supported OS, I'm also fine with emptying that folder out down to the bare minimum.
On 03/01/2020 00:53, Brett Cannon wrote:
That whole directory is mostly outdated (e.g. those Wing files are two major versions behind and we have ripped out all other editor-specific files in the repo). I think the first question is what do we want for that directory to be? Based on that we can decide if something like AIX build instructions makes sense or if we should just gut the directory.
For me personally, I'm torn. While helping out other folks using AIX through that text file might be good due to the work you put in, Michael, while not being an officially supported OS, I'm also fine with emptying that folder out down to the bare minimum.
Yes, I am sad that my support is not sufficient for closing the gap to being a recognized platform. No additional discussion. IMHO - while AIX may not be important to Python - Python working properly is important for AIX users who need applications developed using Python. My start came about because I was asked to help to get a Python application working - and that continues to be my primary area of interest - supporting users. In that sense - supporting users (and I see someone doing a self-build as a user) I am willing to re-work the information needed to build Python3 on AIX. Where the file is stored is not exciting. IMHO, not having that directory may make it easier to find. I only found it by using find, xargs, and grep. Fast forward - thank you Petr - I'll get something started and add a link, read replace the current contents with a link, once I have something - and whether this info ever becomes part of the distribution, or not - is something that can be determined later.
_______________________________________________ Python-Dev mailing list -- python-dev@python.org To unsubscribe send an email to python-dev-leave@python.org https://mail.python.org/mailman3/lists/python-dev.python.org/ Message archived at https://mail.python.org/archives/list/python-dev@python.org/message/O5KPNXWT... Code of Conduct: http://python.org/psf/codeofconduct/
First - best wishes all for a happy and healthy 2020!
As my nickname implies - my primary means to contribute to Python is with regard to AIX. One of the things I recently came across is Misc/README.AIX which was last updated sometime between 2010 and 2014. I am thinking a facelift is in order. Assuming 2010-2011 as the original date - much has changed and many of the comments are no longer accurate.
Before saying so, I would like to check here that - having all tests pass on the 3.8 bot implies that there are no outstanding issues. As to the historical issues in the current document - these could either be deleted, or a short text describing when they were resolved (e.g., Python 3.7, or just resolved, but noone knows exactly how or when - whether it was a Python change, or a platform (AIX) change. Delete them. The README's history is in Git. If you know additional
On 2019-12-26 14:35, Michael wrote: details (like when an issue was resolved), you can say that in the commit message.
What I see as being more relevant is the description re: how to build Python for AIX - for the "do it youself"-ers. So, besides the direct question re: what to say about the old "known issues" and whether there are no known issues aka, no issues identified via the standard tests - I would appreciate feedback on what is considered appropriate - anno 2020 - for any Misc/README.platform text.
Additionally, I am willing to work on other areas of the standard documentation where it is either needed or considered appropriate for platform specific details and/or examples.
This is not something I would try to get done in a single PR, Instead I am thinking a single -longer term- issue - and multiple PR's to work through corrections and additions during 2020. Focus on Python 3.9 and beyond yet where appropriate backlevel to Python 3.8 or even 3.7.
Sincerely,
Michael
Some devs have been setting GitHub repositories for larger projects, with issues (TODO lists), collaboration, wikis or even blog-like documentation. For example: https://github.com/ericsnowcurrently/multi-core-python https://faster-cpython.readthedocs.io/ https://github.com/python/typing https://github.com/python/asyncio It helps to have a space where you can focus on a task without having to prove that "this is good for CPython right now" *all* the time. You could replace README.AIX text with a link there. Afterwards, I think the devguide or Python documentation could link to such a space for the AIX build instructions; then, when finalized, the instructions themselves could be in Python docs or in a new README.AIX. But I do recommend to separate writing the text from proposing it for inclusion in CPython.
participants (3)
-
Brett Cannon -
Michael -
Petr Viktorin