This is an archive of the discontinued LLVM Phabricator instance.

Paths

Table of Contentst

-
llvm/docs/
-
docs/
2/2
Passes.rst

Differential D157644

[Docs] Remove old HTML related comment from Passes documentation
ClosedPublic

Authored by aidengrossman on Aug 10 2023, 12:35 PM.

Download Raw Diff

Details

Reviewers

aeubanks
nikic
fhahn

Commits

rGb2c292c5b120: [Docs] Remove old HTML related comment from Passes documentation

Summary

This patch removes a comment at the top of the Passes.rst file which was
related to checking if the HTML documentation was up to date. It was
moved over as part of the original transition to restructured text and
never modified for some reason. Given that this comment has been
irrelevant for the past 10 years, it should be removed.

Diff Detail

Repository: rG LLVM Github Monorepo

Event Timeline

aidengrossman created this revision.Aug 10 2023, 12:35 PM

Herald added a project: Restricted Project. · View Herald TranscriptAug 10 2023, 12:35 PM

aidengrossman requested review of this revision.Aug 10 2023, 12:35 PM

Herald added a project: Restricted Project. · View Herald TranscriptAug 10 2023, 12:35 PM

Herald added a subscriber: llvm-commits. · View Herald Transcript

Probably should write an updated version at some point (and maybe integrate it with Github actions) since there is a lot of code debt in the passes documentation currently, but I'll leave that for a future patch.

Herald added a subscriber: StephenFan. · View Herald TranscriptAug 10 2023, 2:04 PM

aeubanks added inline comments.Aug 10 2023, 2:10 PM

llvm/docs/Passes.rst
30	this line should stay?

Address reviewer feedback.

llvm/docs/Passes.rst
30	It works either way. I deleted it as I was referencing some of the examples from `llvm/docs/CommandGuide` and none of them use it and it still generates the `<h1>` tag. I'll readd it to not make the diff any bigger than it needs to be and for consistency with the rest of the `llvm/docs/*` pages. I don't think there's a preferred way to do it in restructured text.

This revision is now accepted and ready to land.Aug 10 2023, 2:17 PM

This revision was landed with ongoing or failed builds.Aug 10 2023, 2:19 PM

Closed by commit rGb2c292c5b120: [Docs] Remove old HTML related comment from Passes documentation (authored by aidengrossman). · Explain Why

This revision was automatically updated to reflect the committed changes.

aidengrossman added a commit: rGb2c292c5b120: [Docs] Remove old HTML related comment from Passes documentation.

Harbormaster completed remote builds in B251783: Diff 549167.Aug 10 2023, 8:35 PM

Revision Contents

Path

Size

llvm/

docs/

Passes.rst

29 lines

Diff 549167

llvm/docs/Passes.rst

	..
	If Passes.html is up to date, the following "one-liner" should print
	an empty diff.

	egrep -e '^<tr><td><a href="#.">-.</a></td><td>.*</td></tr>$' \
	-e '^ <a name=".">.</a>$' < Passes.html >html; \
	perl >help <<'EOT' && diff -u help html; rm -f help html
	open HTML, "<Passes.html" or die "open: Passes.html: $!\n";
	while (<HTML>) {
	m:^<tr><td><a href="#(.)">-.</a></td><td>.*</td></tr>$: or next;
	$order{$1} = sprintf("%03d", 1 + int %order);
	}
	open HELP, "../Release/bin/opt -help\|" or die "open: opt -help: $!\n";
	while (<HELP>) {
	m:^ -([^ ]+) +- (.*)$: or next;
	my $o = $order{$1};
	$o = "000" unless defined $o;
	push @x, "$o<tr><td><a href=\"#$1\">-$1</a></td><td>$2</td></tr>\n";
	push @y, "$o <a name=\"$1\">-$1: $2</a>\n";
	}
	@x = map { s/^\d\d\d//; $_ } sort @x;
	@y = map { s/^\d\d\d//; $_ } sort @y;
	print @x, @y;
	EOT

	This (real) one-liner can also be helpful when converting comments to HTML:

	perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ ///? ?::; print " <p>\n" if !$on && $_ =~ /\S/; print " </p>\n" if $on && $_ =~ /^\s$/; print " $_\n"; $on = ($_ =~ /\S/); } print " </p>\n" if $on'

	====================================			====================================
	aeubanksUnsubmitted Done Reply Inline Actions this line should stay? aeubanks: this line should stay?
	aidengrossmanAuthorUnsubmitted Done Reply Inline Actions It works either way. I deleted it as I was referencing some of the examples from `llvm/docs/CommandGuide` and none of them use it and it still generates the `<h1>` tag. I'll readd it to not make the diff any bigger than it needs to be and for consistency with the rest of the `llvm/docs/` pages. I don't think there's a preferred way to do it in restructured text. aidengrossman:* It works either way. I deleted it as I was referencing some of the examples from…
	LLVM's Analysis and Transform Passes			LLVM's Analysis and Transform Passes
	====================================			====================================

	.. contents::			.. contents::
	:local:			:local:

	Introduction			Introduction
	============			============
	▲ Show 20 Lines • Show All 1,196 Lines • Show Last 20 Lines