github.com/MikyChow/arbitrum-go-ethereum@v0.0.0-20230306102812-078da49636de/common/debug.go (about)

     1  // Copyright 2015 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package common
    18  
    19  import (
    20  	"fmt"
    21  	"os"
    22  	"runtime"
    23  	"runtime/debug"
    24  	"strings"
    25  )
    26  
    27  // Report gives off a warning requesting the user to submit an issue to the github tracker.
    28  func Report(extra ...interface{}) {
    29  	fmt.Fprintln(os.Stderr, "You've encountered a sought after, hard to reproduce bug. Please report this to the developers <3 https://github.com/ethereum/go-ethereum/issues")
    30  	fmt.Fprintln(os.Stderr, extra...)
    31  
    32  	_, file, line, _ := runtime.Caller(1)
    33  	fmt.Fprintf(os.Stderr, "%v:%v\n", file, line)
    34  
    35  	debug.PrintStack()
    36  
    37  	fmt.Fprintln(os.Stderr, "#### BUG! PLEASE REPORT ####")
    38  }
    39  
    40  // PrintDeprecationWarning prints the given string in a box using fmt.Println.
    41  func PrintDeprecationWarning(str string) {
    42  	line := strings.Repeat("#", len(str)+4)
    43  	emptyLine := strings.Repeat(" ", len(str))
    44  	fmt.Printf(`
    45  %s
    46  # %s #
    47  # %s #
    48  # %s #
    49  %s
    50  
    51  `, line, emptyLine, str, emptyLine, line)
    52  }