From 17e682a0c5689a8c28ca43a643072c393708db1d Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Mon, 10 Jul 2023 14:00:01 +0800 Subject: [PATCH] Correct typos and link issues in release notes. --- docs/background/releases.rst | 28 ++++++++++++++-------------- docs/spelling_wordlist | 4 ++++ tox.ini | 2 +- 3 files changed, 19 insertions(+), 15 deletions(-) diff --git a/docs/background/releases.rst b/docs/background/releases.rst index 1ad70f806..048d8347f 100644 --- a/docs/background/releases.rst +++ b/docs/background/releases.rst @@ -15,46 +15,46 @@ Features * Android support was upgraded to use Java 17 for builds. (`#1065 `__) * On Linux, Docker Desktop and rootless Docker are now supported. (`#1083 `__) * The company/author name in the installation path for Windows MSI installers is now optional. (`#1199 `__) -* macOS code signing is now multithreaded (and therefore much faster!) (`#1201 `__) +* macOS code signing is now multi-threaded (and therefore much faster!) (`#1201 `__) * Briefcase will now honor PEP-621 project fields where they map to Briefcase configuration items. (`#1203 `__) Bugfixes -------- * XML compatibility warnings generated by the Android build have been cleaned up. (`#827 `__) -* Non ASCII characters provided in the ``briefcase new`` wizard are quoted before being put into pyproject.toml. (`#1011 `__) +* Non ASCII characters provided in the ``briefcase new`` wizard are quoted before being put into ``pyproject.toml``. (`#1011 `__) * Requests to the web server are now recorded in the log file. (`#1090 `__) * An "Invalid Keystore format" error is no longer raised when signing an app if the local Android keystore was generated with a recent version of Java. (`#1112 `__) * Content before a closing square bracket (``]``) or ``.so)`` is no longer stripped by the macOS and iOS log filter. (`#1179 `__) * The option to run Linux system packages through Docker was removed. (`#1207 `__) -* Error handling for incomplete or corrupted Github clones of templates has been improved. (`#1210 `__) -* Application/Bundle IDs are normalized to replace underscores with dashes when possible (`#1234 `__) -* Filenames and directories in RPM package definitions are quoted in order to include filenames that include whitespace. (`#1236 `__) -* Briefcase will no longer display progress bars if the ``FORCE_COLOR`` environment variable is set. (`#1267 `__) -* When creating a new Briefcase project, the header line in ``pyproject.toml`` now contains the version of Briefcase instead of "Unknown". (`#1276 `__) -* Android logs no longer include timestamp and PID, making them easier to read on narrow screens. (`#1286 `__) +* Error handling for incomplete or corrupted Github clones of templates has been improved. (`#1210 `__) +* Application/Bundle IDs are normalized to replace underscores with dashes when possible (`#1234 `__) +* Filenames and directories in RPM package definitions are quoted in order to include filenames that include white space. (`#1236 `__) +* Briefcase will no longer display progress bars if the ``FORCE_COLOR`` environment variable is set. (`#1267 `__) +* When creating a new Briefcase project, the header line in ``pyproject.toml`` now contains the version of Briefcase instead of "Unknown". (`#1276 `__) +* Android logs no longer include timestamp and PID, making them easier to read on narrow screens. (`#1286 `__) * An warning is no longer logged if the Java identified by macOS is not usable by Briefcase. (`#1305 `__) -* Incompabitilies with Cookiecutter 2.2.0 have been resolved. (`#1347 `__) +* Incompatibilities with Cookiecutter 2.2.0 have been resolved. (`#1347 `__) Backward Incompatible Changes ----------------------------- -* Names matching modules in the Python standard library, and ``main``, can no longer be used as an appname. (`#853 `__) -* The ``--no-sign`` option for packaging was removed. Briefcase will now prompt for a signing identity during packging, falling back to adhoc/no signing as a default where possible. (`#865 `__) +* Names matching modules in the Python standard library, and ``main``, can no longer be used as an application name. (`#853 `__) +* The ``--no-sign`` option for packaging was removed. Briefcase will now prompt for a signing identity during packaging, falling back to adhoc/no signing as a default where possible. (`#865 `__) * The version of OpenJDK for Java was updated from 8 to 17. Any Android apps generated on previous versions of Briefcase must be re-generated by running ``briefcase create android gradle``. If customizations were made to files within the generated app, they will need to be manually re-applied after re-running the create command. (`#1065 `__) -* Flatpak apps no longer default to using the Freedesktop runtime and SDK version 21.08 when a runtime is not specified. Instead, the runtime now must be explicitly defined in the `application configuration `__. (`#1272 `__) +* Flatpak apps no longer default to using the Freedesktop runtime and SDK version 21.08 when a runtime is not specified. Instead, the runtime now must be explicitly defined in the `application configuration `__. (`#1272 `__) Documentation ------------- -* All code blocks were updated to add a button to copy the relevant contents on to the user's clipboard. (`#1213 `__) +* All code blocks were updated to add a button to copy the relevant contents on to the user's clipboard. (`#1213 `__) * The limitations of using WebKit2 in AppImage were documented. (`#1322 `__) Misc ---- -* `#856 `__, `#1093 `__, `#1178 `__, `#1181 `__, `#1186 `__, `#1187 `__, `#1191 `__, `#1192 `__, `#1193 `__, `#1195 `__, `#1197 `__, `#1200 `__, `#1204 `__, `#1205 `__, `#1206 `__, `#1215 `__, `#1226 `__, `#1228 `__, `#1232 `__, `#1233 `__, `#1239 `__, `#1241 `__, `#1242 `__, `#1243 `__, `#1244 `__, `#1246 `__, `#1248 `__, `#1249 `__, `#1253 `__, `#1254 `__, `#1255 `__, `#1257 `__, `#1258 `__, `#1262 `__, `#1263 `__, `#1264 `__, `#1265 `__, `#1273 `__, `#1274 `__, `#1279 `__, `#1282 `__, `#1283 `__, `#1284 `__, `#1293 `__, `#1294 `__, `#1295 `__, `#1299 `__, `#1300 `__, `#1301 `__, `#1310 `__, `#1311 `__, `#1316 `__, `#1317 `__, `#1323 `__, `#1324 `__, `#1333 `__, `#1334 `__, `#1335 `__, `#1336 `__, `#1339 `__, `#1341 `__, `#1350 `__, `#1351 `__ +* `#856 `__, `#1093 `__, `#1178 `__, `#1181 `__, `#1186 `__, `#1187 `__, `#1191 `__, `#1192 `__, `#1193 `__, `#1195 `__, `#1197 `__, `#1200 `__, `#1204 `__, `#1205 `__, `#1206 `__, `#1215 `__, `#1226 `__, `#1228 `__, `#1232 `__, `#1233 `__, `#1239 `__, `#1241 `__, `#1242 `__, `#1243 `__, `#1244 `__, `#1246 `__, `#1248 `__, `#1249 `__, `#1253 `__, `#1254 `__, `#1255 `__, `#1257 `__, `#1258 `__, `#1262 `__, `#1263 `__, `#1264 `__, `#1265 `__, `#1273 `__, `#1274 `__, `#1279 `__, `#1282 `__, `#1283 `__, `#1284 `__, `#1293 `__, `#1294 `__, `#1295 `__, `#1299 `__, `#1300 `__, `#1301 `__, `#1310 `__, `#1311 `__, `#1316 `__, `#1317 `__, `#1323 `__, `#1324 `__, `#1333 `__, `#1334 `__, `#1335 `__, `#1336 `__, `#1339 `__, `#1341 `__, `#1350 `__, `#1351 `__ 0.3.14 (2023-04-12) diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist index 28aaa975d..a46cf65e7 100644 --- a/docs/spelling_wordlist +++ b/docs/spelling_wordlist @@ -12,7 +12,9 @@ Bugfix Bugfixes checkmarks codebase +Cookiecutter cryptographic +customizations dev dialogs distributable @@ -22,10 +24,12 @@ Dockerfile dr embeddable executables +Freedesktop Flathub flatpak Flatpak Flatpaks +Github gradle Gradle gradlew diff --git a/tox.ini b/tox.ini index e05e8cf5c..dee1eb71c 100644 --- a/tox.ini +++ b/tox.ini @@ -99,8 +99,8 @@ passenv = PYENCHANT_LIBRARY_PATH commands = !lint-!all : python -m sphinx {[docs]sphinx_args} -b html . {[docs]build_dir}/html - lint : python -m sphinx {[docs]sphinx_args_extra} -b linkcheck . {[docs]build_dir}/links lint : python -m sphinx {[docs]sphinx_args_extra} -b spelling . {[docs]build_dir}/spell + lint : python -m sphinx {[docs]sphinx_args_extra} -b linkcheck . {[docs]build_dir}/links all : python -m sphinx {[docs]sphinx_args_extra} -b html . {[docs]build_dir}/html [testenv:package]