diff options
| author | mike bayer <mike_mp@zzzcomputing.com> | 2023-03-01 21:26:15 +0000 |
|---|---|---|
| committer | Gerrit Code Review <gerrit@bbpush.zzzcomputing.com> | 2023-03-01 21:26:15 +0000 |
| commit | bbc56256572f0753466a15284eaf3602f48d2cc9 (patch) | |
| tree | ded20b1682ac219881ff8b7a070dfe8be3b6932c /docs/build | |
| parent | 82693a8c2c8bce066899fd0336b4be2407f9b260 (diff) | |
| parent | a55f79a109008e79f740ab40e6a9fc597785cbbe (diff) | |
| download | alembic-bbc56256572f0753466a15284eaf3602f48d2cc9.tar.gz | |
Merge "add recursive_version_locations option for searching revision files" into main
Diffstat (limited to 'docs/build')
| -rw-r--r-- | docs/build/tutorial.rst | 10 | ||||
| -rw-r--r-- | docs/build/unreleased/760.rst | 8 |
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/build/tutorial.rst b/docs/build/tutorial.rst index 8540be1..8823a91 100644 --- a/docs/build/tutorial.rst +++ b/docs/build/tutorial.rst @@ -177,6 +177,11 @@ The file generated with the "generic" configuration looks like:: # version_path_separator = space version_path_separator = os # Use os.pathsep. Default configuration used for new projects. + # set to 'true' to search source files recursively + # in each "version_locations" directory + # new in Alembic version 1.10 + # recursive_version_locations = false + # the output encoding used when revision files # are written from script.py.mako # output_encoding = utf-8 @@ -332,6 +337,11 @@ This file contains the following features: It should be defined if multiple ``version_locations`` is used. See :ref:`multiple_bases` for examples. +* ``recursive_version_locations`` - when set to 'true', revision files + are searched recursively in each "version_locations" directory. + + .. versionadded:: 1.10 + * ``output_encoding`` - the encoding to use when Alembic writes the ``script.py.mako`` file into a new migration file. Defaults to ``'utf-8'``. diff --git a/docs/build/unreleased/760.rst b/docs/build/unreleased/760.rst new file mode 100644 index 0000000..5f46e10 --- /dev/null +++ b/docs/build/unreleased/760.rst @@ -0,0 +1,8 @@ +.. change:: + :tags: feature, revisioning + :tickets: 760 + + Recursive traversal of revision files in a particular revision directory is + now supported, by indicating ``recursive_version_locations = true`` in + alembic.ini. Pull request courtesy ostr00000. + |