From 42c7c489f23b8fa84f01783519c1aa65000e0f54 Mon Sep 17 00:00:00 2001 From: Vladyslav Drok Date: Wed, 16 Nov 2016 18:35:13 +0200 Subject: [PATCH] Update the alembic migration section in the developer FAQ After we've introduced a migration that relies on CONF option in commit 1514b2a2f6, following the instruction steps will lead to an ImportError. Change direct usage of the alembic command to calling ironic-dbsync from the virtualenv. Change-Id: I28e51e45c4e5cdb223795dbb4d720d233cd57808 --- doc/source/dev/faq.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/source/dev/faq.rst b/doc/source/dev/faq.rst index df74e409c4..4edc25f966 100644 --- a/doc/source/dev/faq.rst +++ b/doc/source/dev/faq.rst @@ -18,14 +18,15 @@ How do I... ...create a migration script template? -------------------------------------- -Using the ``alembic revision`` command, e.g:: +Using the ``ironic-dbsync revision`` command, e.g:: - $ cd ironic/ironic/db/sqlalchemy - $ alembic revision -m "create foo table" + $ cd ironic + $ tox -evenv -- ironic-dbsync revision -m \"create foo table\" -For more information see the `alembic documentation`_. +It will create an empty alembic migration. For more information see the +`alembic documentation`_. -.. _`alembic documentation`: https://alembic.readthedocs.org/en/latest/tutorial.html#create-a-migration-script +.. _`alembic documentation`: http://alembic.zzzcomputing.com/en/latest/tutorial.html#create-a-migration-script ...know if a release note is needed for my change? --------------------------------------------------