Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Mejorar las instrucciones de migración de versiones #1839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 24, 2022
Merged

Mejorar las instrucciones de migración de versiones #1839

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 61 additions & 10 deletions .overrides/upgrade-python-version.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,42 +1,93 @@
:orphan:

=======================================
How to update to a new Python version
=======================================
How to update to a new Python version
=====================================

We are currently in branch 3.7, and we want to update the strings from 3.8.
We are currently in branch 3.10, and we want to update the strings from 3.11.


#. Fetch the `lastet commit of 3.8 branch <https://github.com/python/cpython/commit/70fe95cdc9ac1b00d4f86b7525dca80caf7003e1>`_::
#. Make sure you are in a clean state of the branch 3.10

#. Create a new branch

#. Fetch the `latest commit of 3.10 branch <https://github.com/python/cpython/commit/69b6b56d857440183e227ca0b10c84bca4239985>`_::

cd cpython/
git fetch --depth 1 origin 70fe95cdc9ac1b00d4f86b7525dca80caf7003e1
git fetch --depth 1 origin 69b6b56d857440183e227ca0b10c84bca4239985

.. note:: you could also base the hash on the 'git tag' from the desired
version: `git checkout tags/v3.11.0 -b 3.11` considering that
`3.11` doesn't exist locally.

#. Checkout that commit locally::

git checkout 70fe95cdc9ac1b00d4f86b7525dca80caf7003e1
git checkout 69b6b56d857440183e227ca0b10c84bca4239985

#. Update the branch on the `Makefile` and check the `requirements.txt` from
the cpython repository, to see if upgrades on the modules like sphinx is
needed.

#. Verify that the docs build with the new versions you changed from
`requirements.txt` mainly the sphinx version.

#. Commit the update of the submodule change::

git add cpython
git commit -m "Update the cpython submodule"

.. note:: This is important, so the later `make build` step will not reset
the cpython submodule to the previous hash on the old branch.

#. Clean possible garbage (form previous builds)::

rm -rf _build ../python-docs-es-pot cpython/Doc/CONTRIBUTING.rst cpython/Doc/upgrade-python-version.rst

.. note: the 'python-docs-es-pot' is a temporary directory that is created
in the next step. It's included here because it might be a leftover
from previous attempts on your machine.

#. Create a virtual environment and install the dependencies of the project::

python -m venv env
source env/bin/activate # Windows: env\Scripts\activate.bat
pip install -r requirements.txt


#. Create the .po files from the new source code. This will generate all the .po files for version 3.8::

SPHINX_GETTEXT=True sphinx-build -j auto -b gettext -d _build/doctrees . ../python-docs-es-pot

.. note::

In `../python-docs-es-pot` directory, we will have the new .pot files with new strings from 3.8 branch.
All these strings will be *unstranslated* at this point.
In `../python-docs-es-pot` directory, we will have the new .pot files with new strings from 3.11 branch.
All these strings will be *untranslated* at this point.

#. Now, we update our translated files form the source language (English) with new strings::

sphinx-intl update --language es --pot-dir ../python-docs-es-pot --locale-dir cpython/locales/

#. Remove `python-docs-cpython/` prefix added by `sphinx-build` to avoid clazy diffs::
#. At this point, all the `.po` files will have a different comment on each translation phrase,
for example::

-#: ../Doc/whatsnew/3.9.rst:3
+#: ../python-docs-es/cpython/Doc/whatsnew/3.9.rst:3

As you can see, it added the path of the local repository, but you can
remove it from it with this regular expression::

sed -i **/*.po -e "s|python-docs-es/cpython/||g"

..note:: if you have your local repository cloned with a different name,
please make sure to adapt the expression.

#. Pass `powrap` to make the column widths consistent::

powrap --modified

#. Prepare for fireworks! Now it's time for an initial build::

make build

you will find many warnings that needs to be fixed before the push
of the new branch is done. So prepare a cup of any hot beverage
and fix them.