package crs

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

Install

dune-project
 Dependency

Authors

Maintainers

Sources

crs-0.0.20250914.tbz
sha256=dad0c46a83ef40da150d8b840b01c66af3b979dfa7c3e17c3edef38aa84b804f
sha512=d7a8b2a34f4a3ddda0eaaa3e4248ec2870f944a5d64782bd73b031637b01e94a378d7534b1c02da739f32343b342ed8e8bf491e6442a3bd7b0e748bd61c58770

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

Module Private.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