Using Hare

These documents cover specific topics related to Hare usage. For a more general introduction to Hare, consider the General language introduction.

Documentation on the standard library, as well as any third-party modules you have installed, is available on the command line with the haredoc tool. The standard library documentation is also available online.

You should have also received the manual pages with your local Hare installation. Manual pages are available for all Hare commands – start with man hare.

Contents

• Using Hare modules
  • Vendoring
  • What files are included?
  • Conditional file inclusion
  • Example program
• API documentation
  • Writing documentation
• Project structure
  • Directory structure
  • Makefiles
• System libraries and C FFI
  • Linking to libraries
  • Application Binary Interface
  • Mixing Hare and C sources
• Linking with assembly code
  • Namespaces & symbols
  • Assembled as one unit
  • Application binary interface
• Cross-compiling
  • The easy way
  • The hard way
• Freestanding Hare programs
  • Building in the freestanding environment
  • Minimum requirements
  • Examples of freestanding programs
• Debugging
  • Debug symbols
  • Runtime errors
• Profiling & performance analysis
  • perf(1)
  • callgrind
  • Memory analysis
• Style guide
  • General conventions
  • Source file organization
  • Function declarations
  • Type declarations
  • Constant declarations
  • Global declarations
  • Type specifiers
  • Values
  • Variables
  • Expressions and operators
  • Casts
  • Postfix expressions
  • Branching expressions
  • Match and switch expressions
• Conventions
  • Informal recommendations for function names
  • Verbs for allocation strategies
  • Informal recommendations for documentation
  • Informal recommendations for errors