Documentation

Overview

    Package grail contains the Init function that all programs are expected to call.

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type Shutdown

    type Shutdown func()

      Shutdown is a function that needs to be called to perform the final cleanup.

      func Init

      func Init() Shutdown

        Init should be called once at the beginning at each executable that doesn't use the github.com/grailbio/base/cmdutil. The Shutdown function should be called to perform the final cleanup (closing logs for example).

        Init also applies a default configuration profile (see package github.com/grailbio/base/config), and adds profile flags to the default flag set. The default profile path used is $HOME/grail/profile.

        Note that this function will call flag.Parse().

        Suggested use:

        shutdown := grail.Init()
        defer shutdown()
        

        Source Files

        Directories

        Path Synopsis
        go