Chiebot-Mirror
/
boringssl
mirror of https://gitee.com/mirrors/boringssl.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

Linkify RFCs in more places in the docs.

Browse Source 
Also don't linkify pipe words in the table of contents. Those are
already inside a link.

Change-Id: Ib984e914bcfe7a8e0216a0553b92100fd034bf36
Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/51605
Reviewed-by: Adam Langley <agl@google.com>
fips-20220613
David Benjamin 3 years ago committed by Adam Langley
parent 4b55af0fc5
commit 81502beedd
1 changed files with 14 additions and 15 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 29
      util/doc.go

29
util/doc.go
Unescape View File

@ -503,7 +503,7 @@ func firstSentence(paragraphs []string) string {
// markupPipeWords converts |s| into an HTML string, safe to be included outside // markupPipeWords converts |s| into an HTML string, safe to be included outside
// a tag, while also marking up words surrounded by |. // a tag, while also marking up words surrounded by |.
func markupPipeWords(allDecls map[string]string, s string) template.HTML { func markupPipeWords(allDecls map[string]string, s string, linkDecls bool) template.HTML {
// It is safe to look for '|' in the HTML-escaped version of |s| // It is safe to look for '|' in the HTML-escaped version of |s|
// below. The escaped version cannot include '|' instead tags because // below. The escaped version cannot include '|' instead tags because
// there are no tags by construction. // there are no tags by construction.
@ -524,12 +524,10 @@ func markupPipeWords(allDecls map[string]string, s string) template.HTML {
if i > 0 && (j == -1 || j > i) { if i > 0 && (j == -1 || j > i) {
ret += "<tt>" ret += "<tt>"
anchor, isLink := allDecls[s[:i]] anchor, isLink := allDecls[s[:i]]
if isLink { if linkDecls && isLink {
ret += fmt.Sprintf("<a href=\"%s\">", template.HTMLEscapeString(anchor)) ret += fmt.Sprintf("<a href=\"%s\">%s</a>", template.HTMLEscapeString(anchor), s[:i])
} } else {
ret += s[:i] ret += s[:i]
if isLink {
ret += "</a>"
} }
ret += "</tt>" ret += "</tt>"
s = s[i+1:] s = s[i+1:]
@ -602,11 +600,12 @@ func generate(outPath string, config *Config) (map[string]string, error) {
headerTmpl := template.New("headerTmpl") headerTmpl := template.New("headerTmpl")
headerTmpl.Funcs(template.FuncMap{ headerTmpl.Funcs(template.FuncMap{
"firstSentence": firstSentence, "firstSentence": firstSentence,
"markupPipeWords": func(s string) template.HTML { return markupPipeWords(allDecls, s) }, "markupPipeWords": func(s string) template.HTML { return markupPipeWords(allDecls, s, true /* linkDecls */) },
"markupFirstWord": markupFirstWord, "markupPipeWordsNoLink": func(s string) template.HTML { return markupPipeWords(allDecls, s, false /* linkDecls */) },
"markupRFC": markupRFC, "markupFirstWord": markupFirstWord,
"newlinesToBR": newlinesToBR, "markupRFC": markupRFC,
"newlinesToBR": newlinesToBR,
}) })
headerTmpl, err := headerTmpl.Parse(`<!DOCTYPE html> headerTmpl, err := headerTmpl.Parse(`<!DOCTYPE html>
<html> <html>
@ -623,12 +622,12 @@ func generate(outPath string, config *Config) (map[string]string, error) {
<a href="headers.html">All headers</a> <a href="headers.html">All headers</a>
</div> </div>
{{range .Preamble}}<p>{{. | markupPipeWords}}</p>{{end}} {{range .Preamble}}<p>{{. | markupPipeWords | markupRFC}}</p>{{end}}
<ol> <ol>
{{range .Sections}} {{range .Sections}}
{{if not .IsPrivate}} {{if not .IsPrivate}}
{{if .Anchor}}<li class="header"><a href="#{{.Anchor}}">{{.Preamble | firstSentence | markupPipeWords}}</a></li>{{end}} {{if .Anchor}}<li class="header"><a href="#{{.Anchor}}">{{.Preamble | firstSentence | markupPipeWordsNoLink}}</a></li>{{end}}
{{range .Decls}} {{range .Decls}}
{{if .Anchor}}<li><a href="#{{.Anchor}}"><tt>{{.Name}}</tt></a></li>{{end}} {{if .Anchor}}<li><a href="#{{.Anchor}}"><tt>{{.Name}}</tt></a></li>{{end}}
{{end}} {{end}}
@ -641,7 +640,7 @@ func generate(outPath string, config *Config) (map[string]string, error) {
<div class="section" {{if .Anchor}}id="{{.Anchor}}"{{end}}> <div class="section" {{if .Anchor}}id="{{.Anchor}}"{{end}}>
{{if .Preamble}} {{if .Preamble}}
<div class="sectionpreamble"> <div class="sectionpreamble">
{{range .Preamble}}<p>{{. | markupPipeWords}}</p>{{end}} {{range .Preamble}}<p>{{. | markupPipeWords | markupRFC}}</p>{{end}}
</div> </div>
{{end}} {{end}}

Write Preview
Loading…
Cancel
Save