GNATformat Documentation

GNATformat Quick CookBook

• 1. Getting Started with GNATformat
  • 1.1. Prerequisites
  • 1.2. GNATformat setup
  • 1.3. The 5-lines manual to GNATformat

GNATformat User’s Manual

• 1. Introduction
  • 1.1. Prerequisites
• 2. How to use GNATformat
  • 2.1. As a command line tool
  • 2.2. As a Git subcommand
  • 2.3. As a library
• 3. Configuring GNATformat
  • 3.1. The command line arguments
  • 3.2. The project file attributes
  • 3.3. Preprocessing
  • 3.4. Formatting Control Regions

GNATformat Formatting options accross GNAT tools

• 1. GNATformat and the GNAT style checks (-gnaty)
• 2. GNATformat and the GNATcheck style checks

GNATformat Custom configurability options

• 1. The configurability of GNATformat
• 2. Unparsing configuration file format
  • 2.1. Top level structure
  • 2.2. Node configurations
  • 2.3. Token configurations
  • 2.4. Document templates
  • 2.5. Expressions
  • 2.6. Patterns
  • 2.7. Bubble up (handling of trivias)
• 3. Configuration snippets examples