Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
CHPL_DEVELOPER.txt
CompilerDebugging.txt
CompilerIRTricks.txt
ContributorInfo.rst
Deprecation.rst
ErrorWarningMessaging.txt
GASNetOnDesktops.txt
GeneratedCode.txt
GettingStarted.txt
NightlyTesting.rst
Potpourri.txt
README
RuntimeLibrary.txt
SpellChecking.rst
TestAnnotationsLocally.txt
TestSystem.rst
Valgrind.rst
buildingdocs.rst

README

=====================
Chapel Best Practices
=====================

This directory contains rough notes intended to be helpful in pointing
out features/quirks of the Chapel development experience for new
developers.  A possible reading order is roughly as follows:

GettingStarted.txt
  A list of suggested "first steps" for new developers.

ContributorInfo.rst
  Information for contributors about setting up github accounts, the
  developer workflow, and testing changes.

Compiler documentation:

  The compiler overview document
    in $CHPL_HOME/doc/rst/developer/compilerOverview

  CompilerDebugging.txt
    Tips on debugging the compiler.

  CompilerIRTricks.txt
    Tips on examining compiler IR during/after compilation.

  ErrorWarningMessaging.txt
    The standard ways to report errors and warnings in Chapel/compiler/runtime.

RuntimeLibrary.txt
  All about the runtime library.

GeneratedCode.txt
  All about compiler-generated code: where it is, timing it,
  debugging/profiling, etc.

GASNetOnDesktops.txt
  Tips on running and debugging Chapel programs with GASNet on your desktop.

GitCheatsheet.rst
  Tips for using git.

CHPL_DEVELOPER.txt
  The most important environment variable you want to set, and what it does.

TestSystem.rst
  All about the Chapel testing system.

SpellChecking.rst
  How to use chplspell to spellcheck the Chapel project.

Potpourri.txt
  Notes not in any of the above categories.

Valgrind.rst
  Building the Chapel compiler so that compiled programs work with valgrind.