From 125207019338d50acd810133350e9be84a1da35b Mon Sep 17 00:00:00 2001 From: Andreas Rumpf Date: Tue, 23 May 2023 13:47:51 +0200 Subject: minor atlas improvements (#21888) * minor atlas improvements * atlas: support a _deps workspace subdirectory --- tools/atlas/atlas.md | 16 ++++++++---- tools/atlas/atlas.nim | 71 +++++++++++++++++++++++++++++++++++++++++---------- 2 files changed, 68 insertions(+), 19 deletions(-) diff --git a/tools/atlas/atlas.md b/tools/atlas/atlas.md index 61ca28ff0..cbdb54b9a 100644 --- a/tools/atlas/atlas.md +++ b/tools/atlas/atlas.md @@ -44,13 +44,15 @@ Thanks to this setup, it's easy to develop multiple projects at the same time. A project plus its dependencies are stored in a workspace: $workspace / main project - $workspace / dependency A - $workspace / dependency B + $workspace / _deps / dependency A + $workspace / _deps / dependency B +The deps directory can be set via `--deps:DIR` explicitly. It defaults to `_deps`. +If you want it to be the same as the workspace use `--deps:.`. -No attempts are being made at keeping directory hygiene inside the -workspace, you're supposed to create appropriate `$workspace` directories -at your own leisure. +You can move a dependency out of the `_deps` subdirectory into the workspace. +This can be convenient should you decide to work on a dependency too. You need to +patch the `nim.cfg` then. ## Commands @@ -85,3 +87,7 @@ Use the .nimble file to setup the project's dependencies. Update every package in the workspace that has a remote URL that matches `filter` if a filter is given. The package is only updated if there are no uncommitted changes. + +### Others + +Run `atlas --help` for more features. diff --git a/tools/atlas/atlas.nim b/tools/atlas/atlas.nim index fe070c969..4662edf9d 100644 --- a/tools/atlas/atlas.nim +++ b/tools/atlas/atlas.nim @@ -29,12 +29,17 @@ Command: the given Nimble file update [filter] update every package in the workspace that has a remote URL that matches `filter` if a filter is given + build|test|doc|tasks currently delegates to `nimble build|test|doc` + task currently delegates to `nimble ` Options: --keepCommits do not perform any `git checkouts` --cfgHere also create/maintain a nim.cfg in the current working directory --workspace=DIR use DIR as workspace + --deps=DIR store dependencies in DIR instead of the workspace + (if DIR is a relative path, it is interpreted to + be relative to the workspace) --version show the version --help show this help """ @@ -63,7 +68,7 @@ type url, commit: string rel: DepRelation # "requires x < 1.0" is silly, but Nimble allows it so we have too. AtlasContext = object - projectDir, workspace: string + projectDir, workspace, depsDir: string hasPackageList: bool keepCommits: bool cfgHere: bool @@ -91,6 +96,20 @@ type include testdata +proc silentExec(cmd: string; args: openArray[string]): (string, int) = + var cmdLine = cmd + for i in 0.. ", result @@ -265,7 +280,10 @@ proc isShortCommitHash(commit: string): bool {.inline.} = commit.len >= 4 and commit.len < 40 proc checkoutCommit(c: var AtlasContext; w: Dependency) = - let dir = c.workspace / w.name.string + var dir = c.workspace / w.name.string + if not dirExists(dir): + dir = c.depsDir / w.name.string + withDir c, dir: if w.commit.len == 0 or cmpIgnoreCase(w.commit, "head") == 0: gitPull(c, w.name) @@ -372,8 +390,8 @@ proc cloneLoop(c: var AtlasContext; work: var seq[Dependency]): seq[string] = let destDir = toDestDir(w.name) let oldErrors = c.errors - if not dirExists(c.workspace / destDir): - withDir c, c.workspace: + if not dirExists(c.workspace / destDir) and not dirExists(c.depsDir / destDir): + withDir c, (if i == 0: c.workspace else: c.depsDir): let err = cloneUrl(c, w.url, destDir, false) if err != "": error c, w.name, err @@ -405,7 +423,9 @@ proc patchNimCfg(c: var AtlasContext; deps: seq[string]; cfgPath: string) = var paths = "--noNimblePath\n" for d in deps: let pkgname = toDestDir d.PackageName - let x = relativePath(c.workspace / pkgname, cfgPath, '/') + let pkgdir = if dirExists(c.workspace / pkgname): c.workspace / pkgname + else: c.depsDir / pkgName + let x = relativePath(pkgdir, cfgPath, '/') paths.add "--path:\"" & x & "\"\n" var cfgContent = configPatternBegin & paths & configPatternEnd @@ -448,14 +468,14 @@ proc installDependencies(c: var AtlasContext; nimbleFile: string) = # 1. find .nimble file in CWD # 2. install deps from .nimble var work: seq[Dependency] = @[] - let (path, pkgname, _) = splitFile(nimbleFile) + let (_, pkgname, _) = splitFile(nimbleFile) let dep = Dependency(name: toName(pkgname), url: "", commit: "") discard collectDeps(c, work, dep, nimbleFile) let paths = cloneLoop(c, work) patchNimCfg(c, paths, if c.cfgHere: getCurrentDir() else: findSrcDir(c)) -proc updateWorkspace(c: var AtlasContext; filter: string) = - for kind, file in walkDir(c.workspace): +proc updateWorkspace(c: var AtlasContext; dir, filter: string) = + for kind, file in walkDir(dir): if kind == pcDir and dirExists(file / ".git"): c.withDir file: let pkg = PackageName(file) @@ -508,6 +528,11 @@ proc main = createDir(val) else: writeHelp() + of "deps": + if val.len > 0: + c.depsDir = val + else: + writeHelp() of "cfghere": c.cfgHere = true else: writeHelp() of cmdEnd: assert false, "cannot happen" @@ -518,6 +543,19 @@ proc main = c.workspace = getCurrentDir() while c.workspace.len > 0 and dirExists(c.workspace / ".git"): c.workspace = c.workspace.parentDir() + + when MockupRun: + c.depsDir = c.workspace + else: + if c.depsDir.len > 0: + if c.depsDir == ".": + c.depsDir = c.workspace + elif not isAbsolute(c.depsDir): + c.depsDir = c.workspace / c.depsDir + else: + c.depsDir = c.workspace / "_deps" + createDir(c.depsDir) + echo "Using workspace ", c.workspace case action @@ -553,13 +591,18 @@ proc main = updatePackages(c) search getPackages(c.workspace), args of "update": - updateWorkspace(c, if args.len == 0: "" else: args[0]) + updateWorkspace(c, c.workspace, if args.len == 0: "" else: args[0]) + updateWorkspace(c, c.depsDir, if args.len == 0: "" else: args[0]) of "extract": singleArg() if fileExists(args[0]): echo toJson(extractRequiresInfo(args[0])) else: error "File does not exist: " & args[0] + of "build", "test", "doc", "tasks": + nimbleExec(action, args) + of "task": + nimbleExec("", args) else: error "Invalid action: " & action -- cgit 1.4.1-2-gfad0 05 +0200 save a backup of csources-built nim to bin/nim_csources to avoid recompiling from csources (#8582)' href='/ahoang/Nim/commit/build_all.sh?h=devel&id=730ce53b71a207edf93abe09c14c150b9c360028'>730ce53b7 ^ 
1ab37ccfc ^

730ce53b7 ^

ab525cc48 ^

bbe49a14a ^

45a5c64c9 ^


3d7d06571 ^

45a5c64c9 ^





ab525cc48 ^


45a5c64c9 ^

730ce53b7 ^






1e89e5bf9 ^

506418ef5 ^

0bb76dde5 ^

e0afacb9f ^

0bb76dde5 ^

3d7d06571 ^



1
2

3

4

5
6
7
8
9

10

11
12
13

14

15
16

17
18
19
20
21
22

23

24

25

26

27

28
29

30

31
32
33
34
35

36
37

38

39
40
41
42
43
44

45

46

47

48

49

50
51
52