package crs

  1. Overview
  2. Docs
A tool for managing inline review comments embedded in source code

Install

dune-project
 Dependency

Authors

Maintainers

Sources

crs-0.0.20260307.tbz
sha256=77f77c61e908a6716fa876f5648f662ffaf7e24be4a7889fd6b53121592311bb
sha512=5fc6252650571c4127ebb1e61fecf78c5d4ce35e2832dff47125cda1448e07ea6d4da5e3a9a28643e3491d3594b0ee8857214241f98bd0296ada2c35ea8daa4b

doc/crs.crs-parser/Crs_parser/Private/Std/Crs_ignore/index.html

Module Std.Crs_ignoreSource

A .crs-ignore file allows listing files and directories that should be ignored when looking for CRs in the tree.

The primary motivation for this is to help managing files that document the CRs system itself. In these files, we often end up with CRs featured as examples. We don't want to conflate them with actual CRs.

Each line specifies a pattern to ignore, relative to the directory where the ignore file is located. in that directory. The format supports:

  # Lines starting with '#' are comments.
  # Blank lines are ignored.

  # Match specific files by basename
  README.md
  test.ml

  # Shell-style patterns are supported
  *.tmp
  test_*.ml

  # Directories can be ignored (affects all contents recursively)
  _build/**
  node_modules/**

The canonical name expected for this files is ".crs-ignore".

Sourcemodule File : sig ... end
Sourcemodule Rules : sig ... end

This module allows to implement some caching or any other useful utils when dealing with all the .crs-ignore files from the tree at once.

Sourcemodule Private : sig ... end