From patchwork Thu Oct 29 15:52:55 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: James Greenhalgh X-Patchwork-Id: 55790 Delivered-To: patch@linaro.org Received: by 10.112.61.134 with SMTP id p6csp641702lbr; Thu, 29 Oct 2015 08:53:23 -0700 (PDT) X-Received: by 10.107.137.213 with SMTP id t82mr4561284ioi.102.1446134003126; Thu, 29 Oct 2015 08:53:23 -0700 (PDT) Return-Path: Received: from sourceware.org (server1.sourceware.org. [209.132.180.131]) by mx.google.com with ESMTPS id eh5si26985845igb.56.2015.10.29.08.53.22 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 29 Oct 2015 08:53:23 -0700 (PDT) Received-SPF: pass (google.com: domain of gcc-patches-return-411988-patch=linaro.org@gcc.gnu.org designates 209.132.180.131 as permitted sender) client-ip=209.132.180.131; Authentication-Results: mx.google.com; spf=pass (google.com: domain of gcc-patches-return-411988-patch=linaro.org@gcc.gnu.org designates 209.132.180.131 as permitted sender) smtp.mailfrom=gcc-patches-return-411988-patch=linaro.org@gcc.gnu.org; dkim=pass header.i=@gcc.gnu.org DomainKey-Signature: a=rsa-sha1; c=nofws; d=gcc.gnu.org; h=list-id :list-unsubscribe:list-archive:list-post:list-help:sender:from :to:cc:subject:date:message-id:mime-version:content-type; q=dns; s=default; b=jjhMCNEshv8B9PvJ0ue078X+8qoYBOp8Vf2rA4NNnVcw4DAlN8 tla5JAayZXJwsL2yNnltP5DFVVrn0vpxa48O53dBJEQx/sNGsi7nWOmYVyYng5ci ylfb5dEDTxNw0sbRM2xCVkF/48P2JkFDERkIWQTS6Ye+VK/QIwFX0UES4= DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=gcc.gnu.org; h=list-id :list-unsubscribe:list-archive:list-post:list-help:sender:from :to:cc:subject:date:message-id:mime-version:content-type; s= default; bh=Eqj0oZ9zQ1EpfTWmnVpEOAbpKHE=; b=iAccUzq1VGBfmKL1a0uN ZLJiNZXy46SaTrQNGWvC+7ZNnas19umSQ1YReXnWPcPjBQUgr4ZjwlPbn+aMFRdk rXpdUzcHkWDpAVWFcf/1T/51cDv1xTCRWBptvCPIUYESE89Oen/optksokIKUtSi qoXwnXeNToAD5r0xbQfEOCA= Received: (qmail 62394 invoked by alias); 29 Oct 2015 15:53:09 -0000 Mailing-List: contact gcc-patches-help@gcc.gnu.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Archive: List-Post: List-Help: Sender: gcc-patches-owner@gcc.gnu.org Delivered-To: mailing list gcc-patches@gcc.gnu.org Received: (qmail 62373 invoked by uid 89); 29 Oct 2015 15:53:08 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-1.8 required=5.0 tests=AWL, BAYES_00, SPF_PASS autolearn=ham version=3.3.2 X-HELO: eu-smtp-delivery-143.mimecast.com Received: from eu-smtp-delivery-143.mimecast.com (HELO eu-smtp-delivery-143.mimecast.com) (207.82.80.143) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Thu, 29 Oct 2015 15:53:07 +0000 Received: from cam-owa1.Emea.Arm.com (fw-tnat.cambridge.arm.com [217.140.96.140]) by eu-smtp-1.mimecast.com with ESMTP id uk-mta-18-6jpngt8pQ1Cso5JCdJ21Xw-1; Thu, 29 Oct 2015 15:53:00 +0000 Received: from e107456-lin.cambridge.arm.com ([10.1.2.79]) by cam-owa1.Emea.Arm.com with Microsoft SMTPSVC(6.0.3790.3959); Thu, 29 Oct 2015 15:53:00 +0000 From: James Greenhalgh To: gcc-patches@gcc.gnu.org Cc: gerald@pfeifer.com, joseph@codesourcery.com, sandra@codesourcery.com Subject: [Docs] Reword the documentation for -fdump-rtl- Date: Thu, 29 Oct 2015 15:52:55 +0000 Message-Id: <1446133975-8796-1-git-send-email-james.greenhalgh@arm.com> MIME-Version: 1.0 X-MC-Unique: 6jpngt8pQ1Cso5JCdJ21Xw-1 X-IsSubscribed: yes Hi, The text for -fdump-rtl- is a little misleading about how much you can derive about pass ordering from the numbers on the dumps. This patch tries to update the text to clarify that (most of the time) you can quite happily derive execution order from these pass numbers. While I'm there I've fixed some missing two-space-after-period issues. Checked that documentation still builds and looks OK in info. OK for trunk? Thanks, James --- 2015-10-29 James Greenhalgh * doc/invoke.texi (fdump-rtl-@var{pass}): Clarify relationship between pass numbering and execution order. diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi index 76fdc31..148f063 100644 --- a/gcc/doc/invoke.texi +++ b/gcc/doc/invoke.texi @@ -6665,17 +6665,19 @@ Says to make debugging dumps during compilation at times specified by @var{letters}. This is used for debugging the RTL-based passes of the compiler. The file names for most of the dumps are made by appending a pass number and a word to the @var{dumpname}, and the files are -created in the directory of the output file. In case of +created in the directory of the output file. In case of @option{=@var{filename}} option, the dump is output on the given file -instead of the pass numbered dump files. Note that the pass number is -computed statically as passes get registered into the pass manager. -Thus the numbering is not related to the dynamic order of execution of -passes. In particular, a pass installed by a plugin could have a -number over 200 even if it executed quite early. @var{dumpname} is -generated from the name of the output file, if explicitly specified -and it is not an executable, otherwise it is the basename of the -source file. These switches may have different effects when -@option{-E} is used for preprocessing. +instead of the pass numbered dump files. Note that the pass number is +assigned as passes are registered into the pass manager. Most passes +will be registered in the order that they will execute and so often the +number will correspond to the pass execution order. However, passes +registered by plugins, which are specific to compilation targets, or +which are otherwise registered after all the other passes, will be +numbered higher than a pass named "final", even if they were executed +earlier. @var{dumpname} is generated from the name of the output +file, if explicitly specified and it is not an executable, otherwise it +is the basename of the source file. These switches may have different +effects when @option{-E} is used for preprocessing. Debug dumps can be enabled with a @option{-fdump-rtl} switch or some @option{-d} option @var{letters}. Here are the possible