Monorepo management for opam overlays
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

monopam: add missing ~sw to 33 docstrings (merlint E410)

All Eio-based functions gained a ~sw:Eio.Switch.t parameter but the
documentation comments were not updated. Fixed across 13 .mli files.

+33 -33
+1 -1
lib/add.mli
··· 8 8 package:string -> 9 9 unit -> 10 10 (unit, Ctx.error) result 11 - (** [run ~proc ~fs ~config ~package ()] looks up the package in the opam repo, 11 + (** [run ~sw ~proc ~fs ~config ~package ()] looks up the package in the opam repo, 12 12 ensures its checkout exists, and pulls the subtree into the monorepo. *)
+1 -1
lib/cross_status.mli
··· 68 68 monopam_config:Config.t -> 69 69 unit -> 70 70 t 71 - (** [compute ~fs ~verse_config ~monopam_config ()] computes cross-user status by 71 + (** [compute ~sw ~fs ~verse_config ~monopam_config ()] computes cross-user status by 72 72 comparing subtrees in my monorepo against all tracked verse members' 73 73 monorepos. 74 74
+1 -1
lib/deps.mli
··· 11 11 dry_run:bool -> 12 12 unit -> 13 13 (unit, string) result 14 - (** [run ~proc ~fs ~target ~dry_run ()] brings the monorepo to a consistent 14 + (** [run ~sw ~proc ~fs ~target ~dry_run ()] brings the monorepo to a consistent 15 15 state: 16 16 17 17 1. Loads [sources.toml] from [target]. If absent, does nothing. 2. For each
+4 -4
lib/diff.mli
··· 70 70 ?patch:bool -> 71 71 unit -> 72 72 result 73 - (** [compute ~proc ~fs ~config ~verse_config ()] computes the diff between local 73 + (** [compute ~sw ~proc ~fs ~config ~verse_config ()] computes the diff between local 74 74 and verse state. *) 75 75 76 76 val show_commit : ··· 83 83 ?refresh:bool -> 84 84 unit -> 85 85 commit_info option 86 - (** [show_commit ~proc ~fs ~config ~verse_config ~sha ()] shows details for a 86 + (** [show_commit ~sw ~proc ~fs ~config ~verse_config ~sha ()] shows details for a 87 87 specific commit in the verse diff. *) 88 88 89 89 (** {1 Pull from Handle} *) ··· 99 99 ?refresh:bool -> 100 100 unit -> 101 101 (handle_pull_result, Ctx.error) Stdlib.result 102 - (** [pull_from_handle ~proc ~fs ~config ~verse_config ~handle ()] pulls changes 102 + (** [pull_from_handle ~sw ~proc ~fs ~config ~verse_config ~handle ()] pulls changes 103 103 from a verse collaborator's handle. *) 104 104 105 105 (** {1 Cherry-pick} *) ··· 114 114 ?refresh:bool -> 115 115 unit -> 116 116 (cherrypick_result, Ctx.error) Stdlib.result 117 - (** [cherrypick ~proc ~fs ~config ~verse_config ~sha ()] cherry-picks a commit 117 + (** [cherrypick ~sw ~proc ~fs ~config ~verse_config ~sha ()] cherry-picks a commit 118 118 from the verse diff. *)
+3 -3
lib/feature.mli
··· 37 37 name:string -> 38 38 unit -> 39 39 (entry, error) result 40 - (** [add ~fs ~config ~name ()] creates a new feature worktree. 40 + (** [add ~sw ~fs ~config ~name ()] creates a new feature worktree. 41 41 42 42 Creates a git worktree at [root/work/<name>] on a new branch named [<name>]. 43 43 ··· 53 53 force:bool -> 54 54 unit -> 55 55 (unit, error) result 56 - (** [remove ~fs ~config ~name ~force ()] removes a feature worktree. 56 + (** [remove ~sw ~fs ~config ~name ~force ()] removes a feature worktree. 57 57 58 58 Removes the worktree at [root/work/<name>]. The branch is not deleted. 59 59 ··· 68 68 config:Verse_config.t -> 69 69 unit -> 70 70 entry list 71 - (** [list ~fs ~config ()] returns all feature worktrees. 71 + (** [list ~sw ~fs ~config ()] returns all feature worktrees. 72 72 73 73 Only returns worktrees in the [root/work/] directory. 74 74
+6 -6
lib/fork_join.mli
··· 146 146 ?dry_run:bool -> 147 147 unit -> 148 148 (fork_result action_plan, error) result 149 - (** [plan_fork ~proc ~fs ~config ~name ?push_url ?dry_run ()] builds a fork 149 + (** [plan_fork ~sw ~proc ~fs ~config ~name ?push_url ?dry_run ()] builds a fork 150 150 plan. 151 151 152 152 This analyzes the current state and builds a list of actions to: ··· 216 216 fs:Eio.Fs.dir_ty Eio.Path.t -> 217 217 fork_result action_plan -> 218 218 (fork_result, error) result 219 - (** [execute_fork_plan ~proc ~fs plan] executes a fork action plan. 219 + (** [execute_fork_plan ~sw ~proc ~fs plan] executes a fork action plan. 220 220 221 221 Returns the fork result with the actual split commit (if applicable). If the 222 222 plan is marked as dry-run, returns the plan's result without executing any ··· 228 228 fs:Eio.Fs.dir_ty Eio.Path.t -> 229 229 join_result action_plan -> 230 230 (join_result, error) result 231 - (** [execute_join_plan ~proc ~fs plan] executes a join action plan. 231 + (** [execute_join_plan ~sw ~proc ~fs plan] executes a join action plan. 232 232 233 233 If the plan is marked as dry-run, returns the plan's result without 234 234 executing any actions. *) ··· 245 245 ?dry_run:bool -> 246 246 unit -> 247 247 (fork_result, error) result 248 - (** [fork ~proc ~fs ~config ~name ?push_url ?dry_run ()] splits a monorepo 248 + (** [fork ~sw ~proc ~fs ~config ~name ?push_url ?dry_run ()] splits a monorepo 249 249 subtree into its own repository. 250 250 251 251 This operation: 1. Validates [mono/<name>/] exists 2. Validates ··· 271 271 ?dry_run:bool -> 272 272 unit -> 273 273 (join_result, error) result 274 - (** [join ~proc ~fs ~config ~url ?name ?upstream ?dry_run ()] brings an external 274 + (** [join ~sw ~proc ~fs ~config ~url ?name ?upstream ?dry_run ()] brings an external 275 275 repository into the monorepo. 276 276 277 277 This operation: 1. Derives name from URL if not provided 2. Validates ··· 297 297 ?dry_run:bool -> 298 298 unit -> 299 299 (join_result, error) result 300 - (** [join_from_verse ~proc ~fs ~config ~verse_config ~package ~handle ~fork_url 300 + (** [join_from_verse ~sw ~proc ~fs ~config ~verse_config ~package ~handle ~fork_url 301 301 ?dry_run ()] joins a package from a verse member's repository. 302 302 303 303 This combines [Verse.fork] (to set up opam entries) with [join]: 1. Looks up
+1 -1
lib/forks.mli
··· 82 82 ?refresh:bool -> 83 83 unit -> 84 84 t 85 - (** [compute ~proc ~fs ~verse_config ~monopam_config ?refresh ()] performs full 85 + (** [compute ~sw ~proc ~fs ~verse_config ~monopam_config ?refresh ()] performs full 86 86 fork analysis by: 1. Scanning my opam repo for dev-repo URLs 2. Scanning all 87 87 verse opam repos for dev-repo URLs 3. Adding git remotes to my checkouts for 88 88 each member's fork 4. Fetching remotes and comparing commit histories
+2 -2
lib/import.mli
··· 65 65 dry_run:bool -> 66 66 unit -> 67 67 (result list, string) Stdlib.result 68 - (** [run ~proc ~fs ~target ~source ~name ~dry_run ()] imports a git repository 68 + (** [run ~sw ~proc ~fs ~target ~source ~name ~dry_run ()] imports a git repository 69 69 as a subtree into [target]. 70 70 71 71 - [source] specifies either a Git URL or a lock file to import from ··· 87 87 dry_run:bool -> 88 88 unit -> 89 89 (result, string) Stdlib.result 90 - (** [git_url ~proc ~fs ~target ~url ~branch ~ref_ ?path ~name ~dry_run ()] 90 + (** [git_url ~sw ~proc ~fs ~target ~url ~branch ~ref_ ?path ~name ~dry_run ()] 91 91 imports a single git URL as a subtree into [target]. When [path] is given, 92 92 [url] is treated as a monorepo and the subtree at [path] is extracted via 93 93 {!Git.Subtree.split} before being merged at [name]. Returns error if the
+4 -4
lib/monopam.mli
··· 117 117 ?refresh:bool -> 118 118 unit -> 119 119 (handle_pull_result, Ctx.error) result 120 - (** [pull_from_handle ~proc ~fs ~config ~verse_config ~handle ()] pulls changes 120 + (** [pull_from_handle ~sw ~proc ~fs ~config ~verse_config ~handle ()] pulls changes 121 121 from a verse collaborator's handle. *) 122 122 123 123 val diff_show_commit : ··· 130 130 ?refresh:bool -> 131 131 unit -> 132 132 commit_info option 133 - (** [diff_show_commit ~proc ~fs ~config ~verse_config ~sha ()] shows details for 133 + (** [diff_show_commit ~sw ~proc ~fs ~config ~verse_config ~sha ()] shows details for 134 134 a specific commit in the verse diff. *) 135 135 136 136 val diff : ··· 144 144 ?patch:bool -> 145 145 unit -> 146 146 Diff.result 147 - (** [diff ~proc ~fs ~config ~verse_config ()] computes the diff between local 147 + (** [diff ~sw ~proc ~fs ~config ~verse_config ()] computes the diff between local 148 148 and verse state. *) 149 149 150 150 val is_commit_sha : string -> bool ··· 160 160 ?refresh:bool -> 161 161 unit -> 162 162 (cherrypick_result, Ctx.error) result 163 - (** [cherrypick ~proc ~fs ~config ~verse_config ~sha ()] cherry-picks a commit 163 + (** [cherrypick ~sw ~proc ~fs ~config ~verse_config ~sha ()] cherry-picks a commit 164 164 from the verse diff. *)
+2 -2
lib/opam_sync.mli
··· 27 27 ?packages:string list -> 28 28 unit -> 29 29 (t, [> `Config_error of string ]) result 30 - (** [run ~fs ~config ?packages ()] syncs opam files from monorepo subtrees to 30 + (** [run ~sw ~fs ~config ?packages ()] syncs opam files from monorepo subtrees to 31 31 the local opam-repo. If [packages] is specified, only syncs those packages. 32 32 *) 33 33 ··· 42 42 ?dry_run:bool -> 43 43 unit -> 44 44 (t, [> `Config_error of string ]) result 45 - (** [run_from_cwd ~fs ~proc ~source ~target ?packages ?no_commit ?dry_run ()] 45 + (** [run_from_cwd ~sw ~fs ~proc ~source ~target ?packages ?no_commit ?dry_run ()] 46 46 syncs opam files from [source] directory to [target] opam-repo. Works from 47 47 any directory, not just the main monorepo. If [no_commit] is true, skips 48 48 auto-commit. If [dry_run] is true, shows what would be exported without
+1 -1
lib/push.mli
··· 11 11 ?force:bool -> 12 12 unit -> 13 13 (unit, Ctx.error) result 14 - (** [run ~proc ~fs ~config ()] exports changes via subtree split and pushes to 14 + (** [run ~sw ~proc ~fs ~config ()] exports changes via subtree split and pushes to 15 15 local checkouts and optionally to remote upstreams. *)
+6 -6
lib/verse.mli
··· 64 64 handle:string -> 65 65 unit -> 66 66 (unit, error) result 67 - (** [init ~proc ~fs ~root ~handle ()] initializes a new opamverse workspace. 67 + (** [init ~sw ~proc ~fs ~root ~handle ()] initializes a new opamverse workspace. 68 68 69 69 Idempotent — if the verse config already exists, this is a no-op. 70 70 ··· 90 90 config:Verse_config.t -> 91 91 unit -> 92 92 (status, error) result 93 - (** [status ~proc ~fs ~config ()] returns the workspace status. 93 + (** [status ~sw ~proc ~fs ~config ()] returns the workspace status. 94 94 95 95 Shows which members are tracked and the state of their local clones. *) 96 96 ··· 101 101 config:Verse_config.t -> 102 102 unit -> 103 103 (Verse_registry.member list, error) result 104 - (** [members ~proc ~fs ~config ()] returns all registry members. 104 + (** [members ~sw ~proc ~fs ~config ()] returns all registry members. 105 105 106 106 Pulls the latest registry before returning the member list. *) 107 107 ··· 113 113 ?handle:string -> 114 114 unit -> 115 115 (unit, error) result 116 - (** [pull ~proc ~fs ~config ?handle ()] syncs all registry members. 116 + (** [pull ~sw ~proc ~fs ~config ?handle ()] syncs all registry members. 117 117 118 118 For each member in the registry, clones or pulls both their monorepo (to 119 119 [verse/<handle>/]) and their opam repo (to [verse/<handle>-opam/]). ··· 129 129 config:Verse_config.t -> 130 130 unit -> 131 131 (unit, error) result 132 - (** [sync ~proc ~fs ~config ()] syncs the workspace. 132 + (** [sync ~sw ~proc ~fs ~config ()] syncs the workspace. 133 133 134 134 Updates the registry and pulls updates for all tracked members. *) 135 135 ··· 177 177 ?dry_run:bool -> 178 178 unit -> 179 179 (fork_result, error) result 180 - (** [fork ~proc ~fs ~config ~handle ~package ~fork_url ?dry_run ()] forks a 180 + (** [fork ~sw ~proc ~fs ~config ~handle ~package ~fork_url ?dry_run ()] forks a 181 181 package from a verse member's opam repo into your workspace. 182 182 183 183 This looks up the package in the member's opam-repo
+1 -1
lib/verse_registry.mli
··· 40 40 config:Verse_config.t -> 41 41 unit -> 42 42 (t, string) result 43 - (** [clone_or_pull ~proc ~fs ~config ()] clones the registry if not present, or 43 + (** [clone_or_pull ~sw ~proc ~fs ~config ()] clones the registry if not present, or 44 44 pulls updates if it exists. Returns the parsed registry contents. 45 45 46 46 The registry is cloned to [config.registry_path].