summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2020-04-13 18:29:46 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2020-04-13 18:33:14 -0400
commit4e5b7e6e62461d2685c1586dbb4cb1db88ff4ab0 (patch)
tree5350be026feb741c24f2d6f2c3cf80a929dee9d1
parent1b1fe518512441959f4ac9c9b715271e2b6d7977 (diff)
downloadsqlalchemy-4e5b7e6e62461d2685c1586dbb4cb1db88ff4ab0.tar.gz
Squashed commit of the following:
commit 571da00f2c6fe905591b398a1e2fbc8ee2d05873 Author: jonathan vanasco <jonathan@2xlp.com> Date: Mon Apr 13 18:16:23 2020 -0400 more examples, as suggested commit c7b154eaf47719923c41498453571e04b6de1141 Author: jonathan vanasco <jonathan@2xlp.com> Date: Mon Apr 13 17:24:47 2020 -0400 consolidating README commit ff294507b664e9c414944a7509a0f71338957fbf Author: jonathan vanasco <jonathan@2xlp.com> Date: Mon Apr 6 14:59:45 2020 -0400 adding example readme plus some mike changes Change-Id: I09a11164df034ddcfe7c4e7d52308ea0b1ec509c
-rw-r--r--doc/build/changelog/README.txt34
-rw-r--r--doc/build/changelog/unreleased_10/README.txt11
-rw-r--r--doc/build/changelog/unreleased_11/README.txt12
-rw-r--r--doc/build/changelog/unreleased_12/README.txt12
-rw-r--r--doc/build/changelog/unreleased_13/README.txt12
-rw-r--r--doc/build/changelog/unreleased_14/README.txt12
6 files changed, 34 insertions, 59 deletions
diff --git a/doc/build/changelog/README.txt b/doc/build/changelog/README.txt
new file mode 100644
index 000000000..65ee529dd
--- /dev/null
+++ b/doc/build/changelog/README.txt
@@ -0,0 +1,34 @@
+Individual per-changelog files are placed into their corresponding release's
+directory (for example: changelog files for the `1.4` branch are placed in the
+`./unreleased_14/` directory, such as `./unreleased_14/4710.rst`).
+
+Files are in `.rst` format, which are pulled in by
+changelog (https://github.com/sqlalchemyorg/changelog; version 0.4.0 or higher)
+to be rendered into their corresponding `changelog_xx.rst` file
+(for example: `./changelog_14.rst`). At release time, the files in the
+`unreleased_xx/` directory are removed and written directly into the changelog.
+
+Rationale is so that multiple changes being merged into Gerrit don't produce
+conflicts. Note that Gerrit does not support alternate merge handlers unlike
+git itself (and the alternate merge handlers don't work that well either).
+
+Each changelog file should be named `{ID}.rst`, wherein `ID` is the unique
+identifier of the issue in the Github issue tracker.
+
+In the example below, the `tags` and `tickets` contain a comma-separated listing
+because there are more than one element.
+
+================================================================================
+ Example Below
+================================================================================
+
+
+.. change::
+ :tags: bug, sql, orm
+ :tickets: 4839, 3257
+
+ Please use reStructuredText and Sphinx markup when possible. For example
+ method :meth:`.Index.create` and parameter
+ :paramref:`.Index.create.checkfirst`, and :class:`.Table` which will
+ subject to the relevant markup. Also please note the indentions required
+ for the text.
diff --git a/doc/build/changelog/unreleased_10/README.txt b/doc/build/changelog/unreleased_10/README.txt
deleted file mode 100644
index 86b91221f..000000000
--- a/doc/build/changelog/unreleased_10/README.txt
+++ /dev/null
@@ -1,11 +0,0 @@
-Individual per-changelog files go here
-in .rst format, which are pulled in by
-changelog (version 0.4.0 or higher) to
-be rendered into the changelog_xx.rst file.
-At release time, the files here are removed and written
-directly into the changelog.
-
-Rationale is so that multiple changes being merged
-into gerrit don't produce conflicts. Note that
-gerrit does not support custom merge handlers unlike
-git itself.
diff --git a/doc/build/changelog/unreleased_11/README.txt b/doc/build/changelog/unreleased_11/README.txt
deleted file mode 100644
index 1d2b3446e..000000000
--- a/doc/build/changelog/unreleased_11/README.txt
+++ /dev/null
@@ -1,12 +0,0 @@
-Individual per-changelog files go here
-in .rst format, which are pulled in by
-changelog (version 0.4.0 or higher) to
-be rendered into the changelog_xx.rst file.
-At release time, the files here are removed and written
-directly into the changelog.
-
-Rationale is so that multiple changes being merged
-into gerrit don't produce conflicts. Note that
-gerrit does not support custom merge handlers unlike
-git itself.
-
diff --git a/doc/build/changelog/unreleased_12/README.txt b/doc/build/changelog/unreleased_12/README.txt
deleted file mode 100644
index 1d2b3446e..000000000
--- a/doc/build/changelog/unreleased_12/README.txt
+++ /dev/null
@@ -1,12 +0,0 @@
-Individual per-changelog files go here
-in .rst format, which are pulled in by
-changelog (version 0.4.0 or higher) to
-be rendered into the changelog_xx.rst file.
-At release time, the files here are removed and written
-directly into the changelog.
-
-Rationale is so that multiple changes being merged
-into gerrit don't produce conflicts. Note that
-gerrit does not support custom merge handlers unlike
-git itself.
-
diff --git a/doc/build/changelog/unreleased_13/README.txt b/doc/build/changelog/unreleased_13/README.txt
deleted file mode 100644
index 1d2b3446e..000000000
--- a/doc/build/changelog/unreleased_13/README.txt
+++ /dev/null
@@ -1,12 +0,0 @@
-Individual per-changelog files go here
-in .rst format, which are pulled in by
-changelog (version 0.4.0 or higher) to
-be rendered into the changelog_xx.rst file.
-At release time, the files here are removed and written
-directly into the changelog.
-
-Rationale is so that multiple changes being merged
-into gerrit don't produce conflicts. Note that
-gerrit does not support custom merge handlers unlike
-git itself.
-
diff --git a/doc/build/changelog/unreleased_14/README.txt b/doc/build/changelog/unreleased_14/README.txt
deleted file mode 100644
index 1d2b3446e..000000000
--- a/doc/build/changelog/unreleased_14/README.txt
+++ /dev/null
@@ -1,12 +0,0 @@
-Individual per-changelog files go here
-in .rst format, which are pulled in by
-changelog (version 0.4.0 or higher) to
-be rendered into the changelog_xx.rst file.
-At release time, the files here are removed and written
-directly into the changelog.
-
-Rationale is so that multiple changes being merged
-into gerrit don't produce conflicts. Note that
-gerrit does not support custom merge handlers unlike
-git itself.
-