Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spelling #164

Closed
wants to merge 2 commits into from
Closed

Spelling #164

wants to merge 2 commits into from

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Feb 5, 2020

Generated by https://github.com/jsoref/spelling f; to maintain your repo, please consider fchurn

Notes:

  • I try to tag things I'm less sure of w/ ??
  • I'm usually more thorough about figuring out which items are third party libraries. For this repo, I didn't. If code comes from an upstream, let me know and I'll shift the changes from this PR to a PR/similar for that upstream
  • @defgroup some instances of this are of the form @defgroup foo foo and others were of the form @defgroup foot foo -- I didn't see any particular indication as to why there was a divergence and some fraction of the time I dropped the trailing t and I think I generally included ?? in my commit messages
  • I generally try to enforce a single spelling for a word. (In some cases for this repo, I let multiple spellings remain as one was dominant and another appeared to be coming from a dependency.)
  • I generally express a preference between en-US and en-GB, although I didn't apply it much here (mostly synchroniz*)
  • I do try to ignore files (you can see what I ignored by looking at https://github.com/strongswan/strongswan/compare/master...jsoref:ignore?expand=1) -- if there are additional files/paths I should ignore, let me know, I just add them (i.e. remove them) in that branch and rebase my work and then rebase back onto master
  • Sometimes I try to address indentation damage when I make changes, I didn't for this repository. I'd rather do that once people are happy w/ the general changes as such things increase the pain of merging/rebasing while I'm working on a PR.
  • Names, email addresses, brands, domains: I generally assume people aren't intentionally misspelling an entity, e.g. strongwan / stronswan. My preference is that for samples things be clearly distinct as opposed to "oh, that's a typo".
  • Yes, I've changed function names, defines, local variables, as well as comments, documentation, and the occasional license header.
  • I'm willing to split things into a limited number of distinct PRs as requested
  • I prefer to squash at the very end, as it's much harder to deal w/ merge conflicts once my changes are squashed.

* accumulating
* acquire
* alignment
* appropriate
* argument
* assign
* attribute
* authenticate
* authentication
* authenticator
* authority
* auxiliary
* brackets
* callback
* camellia
* can't
* cancelability
* certificate
* choinyambuu
* chunk
* collector
* collision
* communicating
* compares
* compatibility
* compressed
* confidentiality
* configuration
* connection
* consistency
* constraint
* construction
* constructor
* database
* decapsulated
* declaration
* decrypt
* derivative
* destination
* destroyed
* details
* devised
* dynamic
* ecapsulation
* encoded
* encoding
* encrypted
* enforcing
* enumerator
* establishment
* excluded
* exclusively
* exited
* expecting
* expire
* extension
* filter
* firewall
* foundation
* fulfillment
* gateways
* hashing
* hashtable
* heartbeats
* identifier
* identifiers
* identities
* identity
* implementers
* indicating
* initialize
* initiate
* initiation
* initiator
* inner
* instantiate
* legitimate
* libraries
* libstrongswan
* logger
* malloc
* manager
* manually
* measurement
* mechanism
* message
* network
* nonexistent
* object
* occurrence
* optional
* outgoing
* packages
* packets
* padding
* particular
* passphrase
* payload
* periodically
* policies
* possible
* previously
* priority
* proposal
* protocol
* provide
* provider
* pseudo
* pseudonym
* public
* qualifier
* quantum
* quintuplets
* reached
* reading
* recommendation to
* recommendation
* recursive
* reestablish
* referencing
* registered
* rekeying
* reliable
* replacing
* representing
* represents
* request
* request
* resolver
* result
* resulting
* resynchronization
* retriable
* revocation
* right
* rollback
* rule
* rules
* runtime
* scenario
* scheduled
* security
* segment
* service
* setting
* signature
* specific
* specified
* speed
* started
* steffen
* strongswan
* subjectaltname
* supported
* threadsafe
* traffic
* tremendously
* treshold
* unique
* uniqueness
* unknown
* until
* upper
* using
* validator
* verification
* version
* version
* warrior
Copy link
Member

@tobiasbrunner tobiasbrunner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for this. The number of typos found is quite impressive considering that we regularly use codespell :) Then again, that uses a relatively small list of common misspellings.

I've added some comments.

src/libcharon/encoding/payloads/cp_payload.h Outdated Show resolved Hide resolved
src/libstrongswan/database/database.h Outdated Show resolved Hide resolved
src/libimcv/ietf/ietf_attr_port_filter.h Show resolved Hide resolved
src/libcharon/sa/task_manager.h Show resolved Hide resolved
src/libstrongswan/resolver/resolver.h Outdated Show resolved Hide resolved
src/libimcv/ietf/ietf_attr_assess_result.h Show resolved Hide resolved
src/libcharon/sa/ikev2/task_manager_v2.c Outdated Show resolved Hide resolved
src/libcharon/bus/bus.h Outdated Show resolved Hide resolved
src/libimcv/ietf/ietf_attr_numeric_version.h Show resolved Hide resolved
@jsoref
Copy link
Contributor Author

jsoref commented Feb 6, 2020

I'm not sure I'll have time tonight, in which case I'll get to this on the weekend.

I'm not terribly surprised at the amount of finds even with your use of codespell, as I've run this tool on other projects that use it. It's obviously better than nothing. And until fairly recently, I haven't offered a user friendly way to integrate my tooling. (I'm finally writing my third round of integrations this week. The first was for checkstyle, the second was removed as it was too painful for a group, and the third I just turned on for my employer yesterday.) As I'm improving my tooling, I'm probably at the point where I could easily generate a table and statistics for suggesting additions to codespell.

Fwiw, for a project of this size and age, I'd say your codebase is about where I'd expect.

And thanks for the prompt response, I know it can be pretty daunting to get such a large PR.

@jsoref
Copy link
Contributor Author

jsoref commented Feb 10, 2020

@tobiasbrunner; I think I've addressed everything...

@tobiasbrunner
Copy link
Member

Thanks, looks good. I think it should be fine to squash all changes into a single commit, except perhaps the "routability" fix (because of the code changes). Would you mind preparing this?

@jsoref
Copy link
Contributor Author

jsoref commented Feb 10, 2020

@tobiasbrunner: done

tobiasbrunner pushed a commit that referenced this pull request Feb 11, 2020
@tobiasbrunner
Copy link
Member

Thanks a lot for your work on this.

@jsoref jsoref deleted the spelling branch March 13, 2022 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants