[asan_symbolize] Move argument parser epilog text into script doc comment.
authorDan Liew <dan@su-root.co.uk>
Tue, 9 Apr 2019 08:30:43 +0000 (08:30 +0000)
committerDan Liew <dan@su-root.co.uk>
Tue, 9 Apr 2019 08:30:43 +0000 (08:30 +0000)
Summary:
This will make it easier to expand on the documentation in the future
that avoids cluttering the code.

rdar://problem/49476995

Reviewers: kubamracek, yln, samsonov, dvyukov, vitalybuka

Subscribers: #sanitizers, llvm-commits

Tags: #llvm, #sanitizers

Differential Revision: https://reviews.llvm.org/D60398

llvm-svn: 357978

compiler-rt/lib/asan/scripts/asan_symbolize.py

index 840e901..c96fb38 100755 (executable)
@@ -6,6 +6,10 @@
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 #
 #===------------------------------------------------------------------------===#
+"""
+Example of use:
+  asan_symbolize.py -c "$HOME/opt/cross/bin/arm-linux-gnueabi-" -s "$HOME/SymbolFiles" < asan.log
+"""
 import argparse
 import bisect
 import getopt
@@ -517,9 +521,7 @@ if __name__ == '__main__':
   parser = argparse.ArgumentParser(
       formatter_class=argparse.RawDescriptionHelpFormatter,
       description='ASan symbolization script',
-      epilog='Example of use:\n'
-             'asan_symbolize.py -c "$HOME/opt/cross/bin/arm-linux-gnueabi-" '
-             '-s "$HOME/SymbolFiles" < asan.log')
+      epilog=__doc__)
   parser.add_argument('path_to_cut', nargs='*',
                       help='pattern to be cut from the result file path ')
   parser.add_argument('-d','--demangle', action='store_true',