docs/sources/cabal.md in licensed-1.0.1 vs docs/sources/cabal.md in licensed-1.1.0

- old
+ new

@@ -1,9 +1,27 @@ # Cabal The cabal source uses the `ghc-pkg` command to enumerate dependencies and provide metadata. It is un-opinionated on GHC packagedb locations and requires some configuration to ensure that all packages are properly found. -The rubygem source will detect dependencies when the source is enabled and a `.cabal` file is found at an apps `source_path`. +The cabal source will detect dependencies when a `.cabal` file is found at an apps `source_path`. By default, the cabal source will enumerate dependencies for all executable and library targets in a cabal file. + +### Specifying which cabal file targets should enumerate dependencies +The cabal source can be configured to override which cabal file targets contain dependencies that need to be documented. + +The default configuration is equivalent to: +```yml +cabal: + cabal_file_targets: + - executable + - library +``` + +However if you only wanted to enumerate dependencies for a `my_cabal_exe` executable target, you could specify: +```yml +cabal: + cabal_file_targets: + - executable my_cabal_exe +``` ### Specifying GHC packagedb locations through environment You can configure the `cabal` source to use specific packagedb locations by setting the `GHC_PACKAGE_PATH` environment variable before running `licensed`. For example, the following is a useful configuration for use with `cabal new-build`.