From 1cafb74bea04aa74149c9b0d8b976f3f100aa5b3 Mon Sep 17 00:00:00 2001 From: gerryRcom Date: Wed, 17 Jul 2024 22:32:47 +0100 Subject: [PATCH] oda spelling check on code doc --- .custom_wordlist.txt | 14 ++++++++++++++ .sphinx/spellingcheck.yaml | 2 +- explanation/code.rst | 12 ++++++------ 3 files changed, 21 insertions(+), 7 deletions(-) diff --git a/.custom_wordlist.txt b/.custom_wordlist.txt index 88c9329..d0ace72 100644 --- a/.custom_wordlist.txt +++ b/.custom_wordlist.txt @@ -39,6 +39,7 @@ boolean breakpoint browserconfig BrowserNotificationMessages +brz bugtracker BugWatch BugWatches @@ -62,6 +63,7 @@ Cmd CMDLINE Cobol codebase +codehosting Codehosting codeimport codeimportscheduler @@ -78,9 +80,11 @@ crontab crontabs cryptographic cryptographically +CSCVS css Ctrl customisable +customisations customize CVE Dalia @@ -111,6 +115,7 @@ dia directDelivery DirectDelivery distro +distros Distro distroseries DistroSeries @@ -126,6 +131,7 @@ doctests docutils downstreams dtrt +dulwich EChangePolicy el else's @@ -154,6 +160,7 @@ fsyncs ftest fti functiondef +ganesha gangotri gina's geoip @@ -167,6 +174,7 @@ gunicorn gzip HackingLazrLibraries hba +hg hirsute's hostnames HSTS @@ -269,6 +277,7 @@ NavigationMenu NavigationMenus né newsampledata +nfs NPM OAuth OEM @@ -332,6 +341,7 @@ POTMsgSet POTMsgSets ppa PPA +pqm PQM pre PreMergeReviews @@ -388,6 +398,7 @@ setUp setupDTCBrowser setupRosettaExpertBrowser setuptools +SFTP simplestreams slony Slony @@ -426,10 +437,12 @@ subclassing subdirectory subprocess subproject +subvertpy sudo SuggestivePOTemplate summarized svg +svn symlinked symlinks synchronize @@ -489,6 +502,7 @@ userbase VBScript vbuilder ViewTests +virt virtualenv virtualenvs VPN diff --git a/.sphinx/spellingcheck.yaml b/.sphinx/spellingcheck.yaml index d21f119..c2a410b 100644 --- a/.sphinx/spellingcheck.yaml +++ b/.sphinx/spellingcheck.yaml @@ -9,7 +9,7 @@ matrix: - .custom_wordlist.txt output: .sphinx/.wordlist.dic sources: - - _build/**/*.html|!_build/explanation/code/index.html|!_build/explanation/security-policy/index.html|!_build/explanation/database-performance/index.html|!_build/explanation/storm-migration-guide/index.html + - _build/**/*.html|!_build/explanation/security-policy/index.html|!_build/explanation/database-performance/index.html|!_build/explanation/storm-migration-guide/index.html pipeline: - pyspelling.filters.html: comments: false diff --git a/explanation/code.rst b/explanation/code.rst index 7a7caa0..79fafbc 100644 --- a/explanation/code.rst +++ b/explanation/code.rst @@ -13,7 +13,7 @@ system. The major sub-systems are: - The `git` and `bzr` / `brz` clients (neither of which is part of Launchpad, but their behaviours are important to us) -- Connectivity to Launchpad (git, git+ssh, and https for Git; sftp and +- Connectivity to Launchpad (git, git+ssh, and https for Git; SFTP and bzr+ssh for Bazaar) - Hosting infrastructure - The underlying object model @@ -29,7 +29,7 @@ Each of these subsystems also have multiple moving parts and some have other asynchronous jobs associated with them. The `codehosting overview diagram `__ -summarizes how some of these systems interact. +summarises how some of these systems interact. You can `run the codehosting system locally `__. @@ -86,14 +86,14 @@ Apache handles the HTTP routing using a number of mod-rewrite rules. '''Parts [and responsibilities] ''' -- HTTP apache configuration [shared with LOSAs] +- HTTP Apache configuration [shared with LOSAs] - branch location rewrite script (called by mod-rewrite rule) - ssh server - - authentication - - sftp implementation + - SFTP implementation - smart server launching - smart server @@ -182,7 +182,7 @@ into Git repositories in Launchpad. - - - cscvs for CVS (and legacy Subversion imports) + - CSCVS for CVS (and legacy Subversion imports) - bzr-svn and subvertpy for all new Subversion imports - bzr-git and dulwich for git - bzr-hg for mercurial imports @@ -192,7 +192,7 @@ Git repository source code browser (cgit) Launchpad uses `cgit `__ to provide a web view of the repository contents. We use an unmodified package of -\`cgit`; Launchpad's customizations are in +\`cgit`; Launchpad's customisations are in `turnip.pack.http `__. Bazaar branch source code browser (loggerhead)