Skip to content

Commit

Permalink
Document force-version
Browse files Browse the repository at this point in the history
  • Loading branch information
andreabedini committed Apr 1, 2022
1 parent 1851bf4 commit 76c6e9b
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,8 +264,7 @@ Foliage also supports patches. Any file with `.patch` extension in
sources.

Patches are applied very early in the process, and they can modify any file
in the source tree. This means one could use a patch to define a new
package version (by changing the version field in the cabal file).
in the source tree.

Revisions are independent of patches, a patched cabal file will be subject
to revisions just like the original cabal file.
Expand All @@ -274,6 +273,14 @@ to revisions just like the original cabal file.
changes the content of the source distribution and the repository can only
provide one source distribution for a given package name and version.

# New package versions

You can introduce new versions of existing packages by patching the cabal
file. Foliage supports a short cut for this use case. If the package
metadata file `<package>/<version>/meta.toml` includes the option
`force-version = true`, then the version in the package cabal file will be
overwritten with `<version>`. Notice this is done after applying patches.

## Author

- Andrea Bedini (@andreabedini)
Expand Down

0 comments on commit 76c6e9b

Please sign in to comment.