From c31b34c628918cfe5ed6de4d8ba77da9f1a27b06 Mon Sep 17 00:00:00 2001 From: Marius Kriegerowski Date: Mon, 8 Nov 2021 18:57:58 +0100 Subject: [PATCH] readme: converted to md and fixed typo Restructured the text a little to improve readibility. Signed-off-by: Marius Kriegerowski --- .gitignore | 3 +++ README => README.md | 15 +++++++-------- lib/pyinotify.py | 2 +- 3 files changed, 11 insertions(+), 9 deletions(-) rename README => README.md (84%) diff --git a/.gitignore b/.gitignore index fbf9eb2031c..f4b6412a4cc 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,6 @@ lib/toaster/contrib/tts/backlog.txt lib/toaster/contrib/tts/log/* lib/toaster/contrib/tts/.cache/* lib/bb/tests/runqueue-tests/bitbake-cookerdaemon.log + +# pycharm +.idea/ diff --git a/README b/README.md similarity index 84% rename from README rename to README.md index 7b4a2b76c00..7ccb93c9faf 100644 --- a/README +++ b/README.md @@ -13,12 +13,11 @@ Bitbake plain documentation can be found under the doc directory or its integrat html version at the Yocto Project website: https://docs.yoctoproject.org -Contributing ------------- +## Contributing Please refer to https://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded -for guidelines on how to submit patches, just note that the latter documentation is intended +for guidelines on how to submit patches. Note that the latter documentation is intended for OpenEmbedded (and its core) not bitbake patches (bitbake-devel@lists.openembedded.org) but in general main guidelines apply. Once the commit(s) have been created, the way to send the patch is through git-send-email. For example, to send the last commit (HEAD) on current @@ -31,18 +30,18 @@ the Yocto Project documentation mailing list: git send-email -M -1 --to bitbake-devel@lists.openembedded.org --cc docs@lists.yoctoproject.org -Mailing list: +### Mailing list https://lists.openembedded.org/g/bitbake-devel -Source code: +### Source code https://git.openembedded.org/bitbake/ -Testing: +## Testing -Bitbake has a testsuite located in lib/bb/tests/ whichs aim to try and prevent regressions. -You can run this with "bitbake-selftest". In particular the fetcher is well covered since +Bitbake has a testsuite located in `lib/bb/tests` which aims to try and prevent regressions. +You can run this with `bitbake-selftest`. In particular the fetcher is well covered since it has so many corner cases. The datastore has many tests too. Testing with the testsuite is recommended before submitting patches, particularly to the fetcher and datastore. We also appreciate new test cases and may require them for more obscure issues. diff --git a/lib/pyinotify.py b/lib/pyinotify.py index 6ae40a2d765..019fbdd9c9b 100644 --- a/lib/pyinotify.py +++ b/lib/pyinotify.py @@ -79,7 +79,7 @@ def __init__(self, version): __version__ = "0.9.6" -# Compatibity mode: set to True to improve compatibility with +# Compatibility mode: set to True to improve compatibility with # Pyinotify 0.7.1. Do not set this variable yourself, call the # function compatibility_mode() instead. COMPATIBILITY_MODE = False