github.com/ari-anchor/sei-tendermint@v0.0.0-20230519144642-dc826b7b56bb/scripts/confix/testdata/README.md (about)

     1  # Test data for `confix` and `condiff`
     2  
     3  The files in this directory are stock Tendermint configuration files generated
     4  by the last point release of each version series from v0.26 to present, along
     5  with diffs between consecutive versions.
     6  
     7  ## Config Samples
     8  
     9  The files named `vXX-config.toml` were generated by checking out and building
    10  the corresponding version of Tendermint v0.xx.y and initializing a new node in
    11  an empty home directory. The resulting `config.toml` file was copied here.
    12  The exact build instructions vary a bit, but a general repro looks like:
    13  
    14  ```shell
    15  # This example uses v0.31, substitute the version of your choice.
    16  # Note that the branch names and tags may differ.
    17  # Versions prior to v0.26 may not build.
    18  git checkout v0.31.9
    19  git clean -fdx
    20  
    21  # Versions prior to v0.32 do not have Go module files.
    22  # Those that do may need some dependencies manually updated.
    23  go mod init github.com/tendermint/tendermint
    24  go mod tidy
    25  go get golang.org/x/sys
    26  
    27  # Once you sort out the dependencies, this should usually work.
    28  make build
    29  
    30  # Confirm you go the version you expected, and generate the file.
    31  ./build/tendermint --home=tmhome version
    32  ./build/tendermint --home=tmhome init
    33  
    34  # Copy the file out.
    35  cp ./tmhome/config/config.toml v31-config.toml
    36  ```
    37  
    38  ## Version Diffs
    39  
    40  The files named `diff-XX-YY.txt` were generated by using the `condiff` tool on
    41  the config samples for versions v0.XX and v0.YY:
    42  
    43  ```shell
    44  go run ./scripts/confix/condiff -desnake vXX-config vYY-config.toml > diff-XX-YY.txt
    45  ```
    46  
    47  The `baseline.txt` was computed in the same way, but using an empty starting
    48  file so that we capture all the settings in the target:
    49  
    50  ```shell
    51  go run ./scripts/confix/condiff -desnake /dev/null v26-config.toml > baseline.txt
    52  ```