github.com/klaytn/klaytn@v1.12.1/cmd/utils/doc.go (about)

     1  // Copyright 2018 The klaytn Authors
     2  // Copyright 2014 The go-ethereum Authors
     3  // This file is part of go-ethereum.
     4  //
     5  // go-ethereum is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // go-ethereum is distributed in the hope that it will be useful,
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    13  // GNU General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU General Public License
    16  // along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
    17  //
    18  // This file is derived from cmd/utils/cmd.go (2018/06/04).
    19  // Modified and improved for the klaytn development.
    20  
    21  /*
    22  Package utils contains internal helper functions for klaytn commands.
    23  
    24  utils package provides various helper functions especially for handling various commands and options.
    25  
    26  Source Files
    27  
    28  Each file contains the following contents
    29   - app.go          : Provides NewCLI() function but it is not being used.
    30   - cmd.go          : Provide import/export chain functions but it is not being used.
    31   - customflags.go  : Provides `DirectoryString`, `DirectoryFlags` and marshaling functions to support custom flags
    32   - files.go        : Provides `WriteFile` function to store contents in a given file
    33   - flags.go        : Defines various flags which can be used in running a node
    34   - flaggroup.go    : Categorizes flags into groups to print structured help descriptions.
    35   - helptemplate.go : Provides a template for help contents which explains option names and its usages
    36   - strings.go      : Provides helper functions to handle string manipulations
    37   - testcmd.go      : Provides test functions to test command arguments
    38   - usage.go        : Provides help printer which prints help contents neatly
    39  */
    40  package utils