[PATCH] D60398: [asan_symbolize] Move argument parser epilog text into script doc comment.

[Dan Liew via Phabricator via llvm-commits]

delcypher created this revision.
delcypher added reviewers: kubamracek, yln, samsonov, dvyukov, vitalybuka.
Herald added projects: LLVM, Sanitizers.
Herald added a subscriber: Sanitizers.

This will make it easier to expand on the documentation in the future
that avoids cluttering the code.

rdar://problem/49476995


Repository:
  rCRT Compiler Runtime

https://reviews.llvm.org/D60398

Files:
  lib/asan/scripts/asan_symbolize.py


Index: lib/asan/scripts/asan_symbolize.py
===================================================================
--- lib/asan/scripts/asan_symbolize.py
+++ lib/asan/scripts/asan_symbolize.py
@@ -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 @@
   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',


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D60398.194099.patch
Type: text/x-patch
Size: 1063 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190408/c60e0aac/attachment.bin>