@@ -234,63 +234,171 @@ if [ ! -f "$USER_DIR/pack.toml" ]; then
234234 # sources or not. This is mainly useful for programmers
235235 # who have set their editor up with some *go to definition*
236236 # functionality (for instance by using idris2-lsp with neovim).
237- with-src = true
237+ # with-src = true
238+
239+ # Whether to install API docs together with installed
240+ # libraries.
241+ # with-docs = false
242+
243+ # Whether to use katla to generate HTML links to
244+ # semantically highlighted API sources
245+ # use-katla = false
238246
239247 # Whether to prompt the user before building or installing
240248 # packages or applications with custom build hooks in their
241- # \` .ipkg\` file.
242- safety-prompt = true
249+ # '.ipkg' file.
250+ # safety-prompt = true
251+
252+ # Whether to prompt the user before running the garbage collector
253+ # via command 'gc'.
254+ # gc-prompt = true
255+
256+ # Whether to remove all outdated libraries and applications during
257+ # garbage collection (command 'gc').
258+ # gc-purge = false
259+
260+ # Whether to issue a warning in presence of a local 'depends' directory
261+ # which might interfere with the libraries managed by pack
262+ # warn-depends = true
263+
264+ # List of packages and apps with custom build hooks we trust to
265+ # be safe. This gives more fine grained control over package safety
266+ # than 'safety-prompt'.
267+ # whitelist = [ "pack", "idris2-lsp" ]
243268
244269 # Must-have libraries. These will be installed automatically
245270 # when using a new package collection.
246- # libs = [ "toml", "elab-util" ]
271+ # Example: 'libs = [ "toml", "elab-util" ]'
272+ # libs = []
247273
248274 # Must-have applications. These will be installed automatically
249275 # when using a new package collection.
250- # apps = [ "idris2-lsp" ]
276+ # Example: 'apps = [ "idris2-lsp" ]'
277+ # apps = []
278+
279+ [pack]
280+
281+ # Override this to use a custom Git repo for pack
282+ # url = "https://github.com/stefan-hoeck/idris2-pack"
283+
284+ # Override this to use a custom commit and branch for pack
285+ # commit = "latest:main"
251286
252287 [idris2]
253288
254289 # Whether to build Idris2 with its bootstrap compiler.
255290 # Bootstrapping takes longer than building with an existing
256291 # Idris2 installation, but it will work even if the existing
257292 # Idris2 compiler is outdated.
258- bootstrap = false
293+ # bootstrap = true
259294
260295 # Name or path to the scheme executable to use.
261296 scheme = "$SCHEME "
262297
263298 # Default code generator to us
264299 # codegen = "chez"
265300
266- # Set this to \` true\` in order to run REPL sessions from within
267- # \` rlwrap\` . This will give you additional features such as a
301+ # Set this to ' true' in order to run REPL sessions from within
302+ # ' rlwrap' . This will give you additional features such as a
268303 # command history.
269- repl.rlwrap = false
304+ # Alternatively, you can pass additional command-line arguments
305+ # to 'rlwrap' by setting this to a string or an array of strings,
306+ # e.g. to "-pGreen -aN" or ["-pGreen", "--no-children"].
307+ # repl.rlwrap = false
308+
309+ # Packages to load automatically when starting a REPL session
310+ # without an '.ipkg' file in scope. This defaults to "none".
311+ # Note: Uncomment only one of the following examples:
312+ # repl.autoload = "installed"
313+ # repl.autoload = "autolibs"
314+ # repl.autoload = [ "sop", "toml" ]
315+
316+ # Override this to use a custom Git repo for the Idris compiler
317+ # url = "https://github.com/idris-lang/Idris2"
318+
319+ # Override this to use a custom commit and branch for the Idris compiler
320+ # commit = "latest:main"
321+
322+ # Override this to have a .gitignore file and .git directory
323+ # created inside of a new pack project upon its creation.
324+ # git = false
325+
326+ # Additional arguments to be passed to the Idris compiler
327+ # This can be a single string or a list of strings.
328+ # extra-args = []
270329
271330 # Below are some examples for custom packages
272331
273332 # A local package to be available with all
274- # package collections.
333+ # package collections. The path to the package's root
334+ # directory can be absolute or relative. In the latter
335+ # case, it will be considered to be relative to the
336+ # parent directory of the 'pack.toml' file where it is
337+ # defined.
338+ #
339+ # The path to '.ipkg' files must always relative to the
340+ # given 'path'.
275341 # [custom.all.chem]
276342 # type = "local"
277343 # path = "/data/idris/chem"
278344 # ipkg = "chem.ipkg"
279345
280- # A package on GitHub to be available with all
346+ # A package as a Git repository to be available with all
281347 # package collections.
282348 # [custom.all.foo]
283- # type = "github "
284- # path = "https://github.com/bar/foo"
349+ # type = "git "
350+ # url = "https://github.com/bar/foo"
285351 # ipkg = "foo.ipkg"
286352
287- # Override library \` toml\` from package collection \` nightly-220503\`
353+ # Override library ' toml' from package collection ' nightly-220503'
288354 # by using a custom commit hash.
289- # [custom.nightly-220503.toml ]
290- # type = "github "
291- # url = "https://github.com/cuddlefishie/toml-idr "
355+ # [custom.nightly-251023.ilex ]
356+ # type = "git "
357+ # url = "https://github.com/stefan-hoeck/idirs2-ilex "
292358 # commit = "eb7a146f565276f82ebf30cb6d5502e9f65dcc3c"
293- # ipkg = "toml.ipkg"
359+ # ipkg = "ilex.ipkg"
360+
361+ # Uncomment and adjust the following entries to specify the
362+ # default log level associated with each pack command.
363+ # Possible log levels are:
364+ # "debug"
365+ # "build"
366+ # "info"
367+ # "cache"
368+ # "warning"
369+ # "silence"
370+ [log]
371+
372+ # build = "build"
373+ # install-deps = "build"
374+ # typecheck = "build"
375+ # clean = "build"
376+ # cleanbuild = "build"
377+ # repl = "warning"
378+ # exec = "warning"
379+ # install = "build"
380+ # install-app = "build"
381+ # remove = "build"
382+ # remove-app = "build"
383+ # run = "warning"
384+ # test = "warning"
385+ # new = "build"
386+ # update = "build"
387+ # fetch = "build"
388+ # package-path = "silence"
389+ # libs-path = "silence"
390+ # data-path = "silence"
391+ # app-path = "silence"
392+ # switch = "build"
393+ # update-db = "build"
394+ # gc = "info"
395+ # info = "cache"
396+ # query = "cache"
397+ # fuzzy = "cache"
398+ # completion = "silence"
399+ # completion-script = "silence"
400+ # uninstall = "info"
401+ # help = "silence"
294402 EOF
295403fi
296404
0 commit comments