From patchwork Fri Jul 24 07:29:48 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Giuliano Procida X-Patchwork-Id: 40170 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id A36263857C42; Fri, 24 Jul 2020 07:29:54 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org A36263857C42 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1595575794; bh=DCm2I1MIuqtPBXHQJpkz1kLerovgotkGzrbUzN6+Pqk=; h=Date:Subject:To:List-Id:List-Unsubscribe:List-Archive:List-Help: List-Subscribe:From:Reply-To:Cc:From; b=TJNdz/ZcDXtkxwTlbTcYAqVBjpXip5njrCUrWDUm7DEv6HUn6eRFHWySb3ETEhM5N Ot2qUZNxcM+RKaReqir7eyq4tupsdun3dTh00Fn0UYj4xi7UJa2aVmSrui1gEQGWvq u60iQH+GepwXHsWBBdDJU8PDv0s2uc3bpYvDGE80= X-Original-To: libabigail@sourceware.org Delivered-To: libabigail@sourceware.org Received: from mail-yb1-xb4a.google.com (mail-yb1-xb4a.google.com [IPv6:2607:f8b0:4864:20::b4a]) by sourceware.org (Postfix) with ESMTPS id 75FFD3857C42 for ; Fri, 24 Jul 2020 07:29:51 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 75FFD3857C42 Received: by mail-yb1-xb4a.google.com with SMTP id k127so9408125ybk.11 for ; Fri, 24 Jul 2020 00:29:51 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:message-id:mime-version:subject:from:to:cc; bh=DCm2I1MIuqtPBXHQJpkz1kLerovgotkGzrbUzN6+Pqk=; b=CGYBZdzPiNXL75yJUQ5V0ypqK8CUd37KMKenCJ2Fv29mYi9TvGhIfTQOgY572SMLmk jhB36Fn5o1oJTzQWl9Pch9BDvrtCHQnuWvpQr0iArQbismU82UWIciemVLM3Mk8RkVYM /1sx/1gT6PEsIXrhFfqL83NOonuni61aSTpe4Y98gas3xGHI65osX7X7QNJ2YSzKxMRF LlH17e00NS3vUS9ffVvZ3B9i2Z9sMbMd4JkMJGZTkIQEism+Lt/Pmh1/IilSfod4a6/P N8KpzF3ybdu4t2r28jVKqlDQpCjc5HKVOqKFSMWmFWnk0jxZNxaBWQaWok5nHNSnyqP8 9Zew== X-Gm-Message-State: AOAM532ko8KR+tDnZ9aRaDiiF0ag0ZtrlmaWc7XFTZ1Lz0H6yhQ9a3m+ 0AId/INKL7lw7GhqCX79a/N1TFJFiOVJSkUJ+D3XHSEQ1dO2n64ka+04Kg3zgjiDzWboDsOTcD1 oJ/3H723GkV0eqYm7g9klFgC0qlAQ7Ls1pwda7HxVmEgS8+tQBE7P9GJFtvnCmVWjJQbsuD0= X-Google-Smtp-Source: ABdhPJyEYIMLFHISBgOYdCZxKoUqLttvkKBpxjFIoqLgtGwt80lOBvxbwHyjKPwttfwV8UoyFevMlWk2eReQOQ== X-Received: by 2002:a25:b29f:: with SMTP id k31mr13189603ybj.90.1595575790872; Fri, 24 Jul 2020 00:29:50 -0700 (PDT) Date: Fri, 24 Jul 2020 08:29:48 +0100 Message-Id: <20200724072948.3850055-1-gprocida@google.com> Mime-Version: 1.0 X-Mailer: git-send-email 2.28.0.rc0.142.g3c755180ce-goog Subject: [PATCH] Improve documentation of abidiff --type-id-style To: libabigail@sourceware.org X-Spam-Status: No, score=-22.5 required=5.0 tests=BAYES_00, DKIMWL_WL_MED, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP, USER_IN_DEF_DKIM_WL autolearn=ham autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on server2.sourceware.org X-BeenThere: libabigail@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Mailing list of the Libabigail project List-Unsubscribe: , List-Archive: List-Help: List-Subscribe: , X-Patchwork-Original-From: Giuliano Procida via Libabigail From: Giuliano Procida Reply-To: Giuliano Procida Cc: kernel-team@android.com Errors-To: libabigail-bounces@sourceware.org Sender: "Libabigail" * tools/abidw.cc (display_usage): In documentation of "--type-id-style" option, add a missing closing ')', spell "type id" without a '-', split overly long string over two lines, use "<...>" to indicate mandatory argument and improve description of formats. * doc/manuals/abidw.rst: In documentation of "--type-id-style" option, use "<...>" to indicate mandatory argument. Signed-off-by: Giuliano Procida --- doc/manuals/abidw.rst | 2 +- tools/abidw.cc | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/manuals/abidw.rst b/doc/manuals/abidw.rst index 5834923b..d0720a0b 100644 --- a/doc/manuals/abidw.rst +++ b/doc/manuals/abidw.rst @@ -197,7 +197,7 @@ Options 1.8 will not set the default size and will interpret types without a size-in-bits attribute as zero sized. - * ``--type-id-style`` ( ``sequence`` | ``hash`` ) + * ``--type-id-style`` <``sequence``|``hash``> This option controls how types are idenfied in the generated XML files. The default ``sequence`` style just numbers (with diff --git a/tools/abidw.cc b/tools/abidw.cc index 2cd848df..27a9e484 100644 --- a/tools/abidw.cc +++ b/tools/abidw.cc @@ -180,7 +180,8 @@ display_usage(const string& prog_name, ostream& out) << " --no-write-default-sizes do not emit pointer size when it equals" " the default address size of the translation unit\n" << " --no-parameter-names do not show names of function parameters\n" - << " --type-id-style (sequence|hash) type-id style (sequence(default): type-id-number; hash: hexdigits\n" + << " --type-id-style type id style (sequence(default): " + "\"type-id-\" + number; hash: hex-digits)\n" << " --check-alternate-debug-info check alternate debug info " "of \n" << " --check-alternate-debug-info-base-name check alternate "