Clarify endpoint rules

[cpaelzer]

I came by this on review today and realized that this isn't meant to be explicitly and only ports/sockets. OTOH it would even be ok to have a low port if there is a reason, hence mention that as well.

[github-actions[bot]]

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view or the :scroll:action log for details.

Unrecognized words (1)

dbus

To accept :heavy_check_mark: these unrecognized words as correct, run the following commands

... in a clone of the [git@github.com:cpaelzer/ubuntu-mir.git](https://github.com/cpaelzer/ubuntu-mir.git) repository on the `endpoints` branch ([:information_source: how do I use this?]( https://github.com/check-spelling/check-spelling/wiki/Accepting-Suggestions)): ``` sh curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' | perl - 'https://github.com/canonical/ubuntu-mir/actions/runs/5573831989/attempts/1' ```

Available :books: dictionaries could cover words not in the :blue_book: dictionary

This includes both **expected items** (10) from .github/actions/spelling/expect.txt and **unrecognized words** (1) Dictionary | Entries | Covers -|-|- [cspell:cpp/src/cpp.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/cpp/src/cpp.txt)|30216|4| [cspell:win32/src/win32.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/win32/src/win32.txt)|53509|2| [cspell:cpp/src/stdlib-c.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/cpp/src/stdlib-c.txt)|290|2| [cspell:ruby/ruby.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/ruby/ruby.txt)|278|1| [cspell:r/src/r.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/r/src/r.txt)|808|1| [cspell:python/src/python/python-lib.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/python/src/python/python-lib.txt)|3873|1| [cspell:php/php.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/php/php.txt)|2597|1| [cspell:fullstack/fullstack.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/fullstack/fullstack.txt)|390|1| [cspell:bash/bash-words.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/bash/bash-words.txt)|117|1| Consider adding them using (in `.github/workflows/spelling.yml`): ``` yml with: extra_dictionaries: cspell:cpp/src/cpp.txt cspell:win32/src/win32.txt cspell:cpp/src/stdlib-c.txt cspell:ruby/ruby.txt cspell:r/src/r.txt cspell:python/src/python/python-lib.txt cspell:php/php.txt cspell:fullstack/fullstack.txt cspell:bash/bash-words.txt ``` To stop checking additional dictionaries, add: ``` yml with: check_extra_dictionaries: '' ```

:pencil2: Contributor please read this

By default the suggested command will add the listed items to the .github/actions/spelling/expect.txt. This is not always desired! If a listed items is * ... **misspelled**, then please *correct* them instead of changing the spell checker configuration. * ... an *actual* word/term that has a high probability of showing up in future contributions, please add it to [`.github/actions/spelling/allow`](https://github.com/canonical/ubuntu-mir/tree/main/.github/actions/spelling/allow). * ... an term/word that just you use or shouldn't generally be accepted, please add it to [`.github/actions/spelling/expect.txt`](https://github.com/canonical/ubuntu-mir/tree/main/.github/actions/spelling/expect.txt). See the `README.md` in each directory for more information. :microscope: You can test your commits **without** *appending* to a PR by creating a new branch with that extra change and pushing it to your fork. The [check-spelling](https://github.com/marketplace/actions/check-spelling) action will run in response to your **push** – it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. :wink:

[dviererbe]

You may want to apply this patch to fix the spell checking error:

diff --git a/.github/actions/spelling/allow/software.txt b/.github/actions/spelling/allow/software.txt
index e6c1355..f8a5b02 100644
--- a/.github/actions/spelling/allow/software.txt
+++ b/.github/actions/spelling/allow/software.txt
@@ -5,6 +5,7 @@ autopkgtest
 autopkgtests
 curl
 dbgsym
+dbus
 debconf
 dpkg
 gettext

[cpaelzer]

You may want to apply this patch

Yep, I had intended to have it run here and then follow up on the checker findings. Done now.

[slyon]

Looks like we have quorum on this one and all comments are resolved. Merging.