Skip to content

Commit 3c97fca

Browse files
committed
Update outdated documentation
The part of the documentation about handling of transitive package dependencies was no longer correct since commit dfeed75. Now it is updated to describe the new behavior. Related to #127
1 parent 820e609 commit 3c97fca

File tree

1 file changed

+11
-23
lines changed

1 file changed

+11
-23
lines changed

readme.markdown

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -228,11 +228,11 @@ query parameter. For example:
228228
### nimble develop
229229

230230
The develop command is used for putting packages in a development mode. When
231-
executed with a list of packages it clones their repository. If it is
232-
executed in a package directory it adds cloned packages to the special
233-
`nimble.develop` file. This is a special file which is used for holding the
234-
paths to development mode dependencies of the current directory package. It has
235-
the following structure:
231+
executed with a list of packages it clones their repository. If it is executed
232+
in a package directory it adds cloned packages to the special `nimble.develop`
233+
file. This is a special file which is used for holding the paths to development
234+
mode dependencies of the current directory package. It has the following
235+
structure:
236236

237237
```json
238238
{
@@ -247,17 +247,15 @@ the following structure:
247247
* `dependencies` - JSON array of paths to Nimble packages directories.
248248

249249
The format for included develop files is the same as the project's develop
250-
file, but their validation works slightly different.
250+
file.
251251

252-
Validation rules:
252+
Develop files validation rules:
253253

254254
* The included develop files must be valid.
255-
* The packages listed in `dependencies` section must be dependencies required
256-
by the package's `.nimble` file and to be in the required by its version range.
257-
Transitive dependencies are not allowed, but this may be changed in the future.
258-
* The packages listed in the included develop files are required to be valid
259-
**Nimble** packages, but they are not required to be valid dependencies of the
260-
current project. In the latter case, they are simply ignored.
255+
* The packages listed in the `dependencies` section and in the included develop
256+
files are required to be valid **Nimble** packages, but they are not required
257+
to be valid dependencies of the current project. In the latter case, they are
258+
simply ignored.
261259
* The develop files of the develop mode dependencies of a package are being
262260
followed and processed recursively. Finally, only one common set of develop
263261
mode dependencies is created.
@@ -300,16 +298,6 @@ executing `develop` command from some package's directory unless
300298
Because the develop files are user-specific and they contain local file system
301299
paths they **MUST NOT** be committed.
302300

303-
**Current limitations:**
304-
305-
* Currently transitive dependencies in the `dependencies` section of the
306-
develop file are not allowed. In the future, they should be allowed because
307-
this will allow using in develop mode some transitive package dependencies
308-
without having in develop mode the full dependency tree path to them. It was a
309-
design mistake that was not allowed at the beginning. The current workaround is
310-
to add the transitive dependency as a dependency in the project's `.nimble`
311-
file.
312-
313301
### nimble lock
314302

315303
The `nimble lock` command will generate or update a package lock file named

0 commit comments

Comments
 (0)