diff options
| -rw-r--r-- | bridge/gitlab/event.go | 9 | ||||
| -rw-r--r-- | cache/repo_cache.go | 16 | ||||
| -rw-r--r-- | commands/bridge/bridge_new.go | 2 | ||||
| -rw-r--r-- | commands/select/select.go | 8 | ||||
| -rw-r--r-- | entities/identity/identity.go | 6 | ||||
| -rw-r--r-- | entities/identity/version.go | 6 | ||||
| -rw-r--r-- | entity/dag/entity_actions.go | 24 |
7 files changed, 36 insertions, 35 deletions
diff --git a/bridge/gitlab/event.go b/bridge/gitlab/event.go index 80663edd..483af921 100644 --- a/bridge/gitlab/event.go +++ b/bridge/gitlab/event.go @@ -5,8 +5,9 @@ import ( "strings" "time" - "github.com/MichaelMure/git-bug/util/text" "github.com/xanzy/go-gitlab" + + "github.com/MichaelMure/git-bug/util/text" ) // Event represents a unified GitLab event (note, label or state event). @@ -204,9 +205,9 @@ func SortedEvents(inputs ...<-chan Event) chan Event { } // getNewTitle parses body diff given by gitlab api and return it final form -// examples: "changed title from **fourth issue** to **fourth issue{+ changed+}**" -// "changed title from **fourth issue{- changed-}** to **fourth issue**" -// because Gitlab +// examples: +// - "changed title from **fourth issue** to **fourth issue{+ changed+}**" +// - "changed title from **fourth issue{- changed-}** to **fourth issue**" func getNewTitle(diff string) string { newTitle := strings.Split(diff, "** to **")[1] newTitle = strings.Replace(newTitle, "{+", "", -1) diff --git a/cache/repo_cache.go b/cache/repo_cache.go index edfe1baf..130500cb 100644 --- a/cache/repo_cache.go +++ b/cache/repo_cache.go @@ -40,14 +40,14 @@ type cacheMgmt interface { // RepoCache is a cache for a Repository. This cache has multiple functions: // -// 1. After being loaded, a Bug is kept in memory in the cache, allowing for fast -// access later. -// 2. The cache maintain in memory and on disk a pre-digested excerpt for each bug, -// allowing for fast querying the whole set of bugs without having to load -// them individually. -// 3. The cache guarantee that a single instance of a Bug is loaded at once, avoiding -// loss of data that we could have with multiple copies in the same process. -// 4. The same way, the cache maintain in memory a single copy of the loaded identities. +// 1. After being loaded, a Bug is kept in memory in the cache, allowing for fast +// access later. +// 2. The cache maintain in memory and on disk a pre-digested excerpt for each bug, +// allowing for fast querying the whole set of bugs without having to load +// them individually. +// 3. The cache guarantee that a single instance of a Bug is loaded at once, avoiding +// loss of data that we could have with multiple copies in the same process. +// 4. The same way, the cache maintain in memory a single copy of the loaded identities. // // The cache also protect the on-disk data by locking the git repository for its // own usage, by writing a lock file. Of course, normal git operations are not diff --git a/commands/bridge/bridge_new.go b/commands/bridge/bridge_new.go index 4cfc903d..2c51d9ef 100644 --- a/commands/bridge/bridge_new.go +++ b/commands/bridge/bridge_new.go @@ -33,7 +33,7 @@ func newBridgeNewCommand() *cobra.Command { cmd := &cobra.Command{ Use: "new", Short: "Configure a new bridge", - Long: ` Configure a new bridge by passing flags or/and using interactive terminal prompts. You can avoid all the terminal prompts by passing all the necessary flags to configure your bridge.`, + Long: "Configure a new bridge by passing flags or/and using interactive terminal prompts. You can avoid all the terminal prompts by passing all the necessary flags to configure your bridge.", Example: `# Interactive example [1]: github [2]: gitlab diff --git a/commands/select/select.go b/commands/select/select.go index b821ba59..694d636a 100644 --- a/commands/select/select.go +++ b/commands/select/select.go @@ -39,10 +39,10 @@ type Resolver[CacheT cache.CacheEntity] interface { // line. If it fails, it falls back to the select mechanism. // // Returns: -// - the entity if any -// - the new list of command line arguments with the entity prefix removed if it -// has been used -// - an error if the process failed +// - the entity if any +// - the new list of command line arguments with the entity prefix removed if it +// has been used +// - an error if the process failed func Resolve[CacheT cache.CacheEntity](repo *cache.RepoCache, typename string, namespace string, resolver Resolver[CacheT], args []string) (CacheT, []string, error) { diff --git a/entities/identity/identity.go b/entities/identity/identity.go index b0cee43b..22ce652c 100644 --- a/entities/identity/identity.go +++ b/entities/identity/identity.go @@ -383,9 +383,9 @@ func (i *Identity) NeedCommit() bool { // cleaning would be required. // // An alternative approach would be to have a determinist rebase: -// - any commits present in both local and remote version would be kept, never changed. -// - newer commits would be merged in a linear chain of commits, ordered based on the -// Lamport time +// - any commits present in both local and remote version would be kept, never changed. +// - newer commits would be merged in a linear chain of commits, ordered based on the +// Lamport time // // However, this approach leave the possibility, in the case of a compromised crypto keys, // of forging a new version with a bogus Lamport time to be inserted before a legit version, diff --git a/entities/identity/version.go b/entities/identity/version.go index 9a52d089..fe1565cf 100644 --- a/entities/identity/version.go +++ b/entities/identity/version.go @@ -15,8 +15,8 @@ import ( ) // 1: original format -// 2: Identity Ids are generated from the first version serialized data instead of from the first git commit -// + Identity hold multiple lamport clocks from other entities, instead of just bug edit +// 2: Identity Ids are generated from the first version serialized data instead of from the first git +// commit + Identity hold multiple lamport clocks from other entities, instead of just bug edit const formatVersion = 2 // version is a complete set of information about an Identity at a point in time. @@ -31,7 +31,7 @@ type version struct { unixTime int64 // The set of keys valid at that time, from this version onward, until they get removed - // in a new version. This allow to have multiple key for the same identity (e.g. one per + // in a new version. This allows to have multiple key for the same identity (e.g. one per // device) as well as revoke key. keys []*Key diff --git a/entity/dag/entity_actions.go b/entity/dag/entity_actions.go index 2a2bf87f..97a68c36 100644 --- a/entity/dag/entity_actions.go +++ b/entity/dag/entity_actions.go @@ -53,18 +53,18 @@ func Pull[EntityT entity.Interface](def Definition, wrapper func(e *Entity) Enti // MergeAll will merge all the available remote Entity: // // Multiple scenario exist: -// 1. if the remote Entity doesn't exist locally, it's created -// --> emit entity.MergeStatusNew -// 2. if the remote and local Entity have the same state, nothing is changed -// --> emit entity.MergeStatusNothing -// 3. if the local Entity has new commits but the remote don't, nothing is changed -// --> emit entity.MergeStatusNothing -// 4. if the remote has new commit, the local bug is updated to match the same history -// (fast-forward update) -// --> emit entity.MergeStatusUpdated -// 5. if both local and remote Entity have new commits (that is, we have a concurrent edition), -// a merge commit with an empty operationPack is created to join both branch and form a DAG. -// --> emit entity.MergeStatusUpdated +// 1. if the remote Entity doesn't exist locally, it's created +// --> emit entity.MergeStatusNew +// 2. if the remote and local Entity have the same state, nothing is changed +// --> emit entity.MergeStatusNothing +// 3. if the local Entity has new commits but the remote don't, nothing is changed +// --> emit entity.MergeStatusNothing +// 4. if the remote has new commit, the local bug is updated to match the same history +// (fast-forward update) +// --> emit entity.MergeStatusUpdated +// 5. if both local and remote Entity have new commits (that is, we have a concurrent edition), +// a merge commit with an empty operationPack is created to join both branch and form a DAG. +// --> emit entity.MergeStatusUpdated // // Note: an author is necessary for the case where a merge commit is created, as this commit will // have an author and may be signed if a signing key is available. |