Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

intra doc links instead of relative file paths #2068

Merged
merged 6 commits into from Apr 14, 2022

Commits on Apr 12, 2022

  1. docs: sed relative links into intra-doc links

    I ran into a few relative links that didn't work right either in the
    original context or in the re-exported context. afaict letting Cargo
    figure out the links works better now.
    
    I used the following definitely very robust and obvious invocation:
    
        find -name \*.rs -exec sed -i -e '
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\.\./\w\+\.\(\w\+\)\.html@\1super::\2@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\.\./\(\w\+\)/\w\+\.\(\w\+\)\.html@\1super::\2::\3@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\.\./\.\./\w\+\.\(\w\+\)\.html@\1super::super::\2@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\.\./\.\./\(\w\+\)/\w\+\.\(\w\+\)\.html@\1super::super::\2::\3@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\.\./\(\w\+\)/index\.html@\1super::\2@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\.\./index\.html@\1super@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\.\./\(\w\+\)/\?$@\1super::\2@;
    
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\./\w\+\.\(\w\+\)\.html@\1self::\2@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\./\(\w\+\)/\w\+\.\(\w\+\)\.html@\1self::\2::\3@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\./\(\w\+\)/index\.html@\1self::\2@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\./index\.html@\1self@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\./\(\w\+\)/\?$@\1self::\2@;
    
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\w\+\.\(\w\+\)\.html@\1self::\2@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\(\w\+\)/\w\+\.\(\w\+\)\.html@\1self::\2::\3@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\(\w\+\)/index\.html@\1self::\2@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?index\.html@\1self@;
            s@\(//. \[[^]]*\]:\s\+\)[:"]\?\(\w\+\)/\?$@\1self::\2@;
    
            s@\(//. \[[^]]*\]:\s\+[A-Za-z_0-9:]\+\)#method\.\(\w\+\)@\1::\2@;
        ' {} +
    ben0x539 committed Apr 12, 2022
    Configuration menu
    Copy the full SHA
    71e7052 View commit details
    Browse the repository at this point in the history
  2. docs: fix/remove now-detected-as-broken intra doc links

    I didn't sed very cleverly so a lot of stuff came out wrong or at least
    ambiguous and awkward, unsurprisingly, so here is some manual fixing-up.
    
    afaict `Callsite:id` hasn't existed in a long time so I went and also
    removed other mentions of it.
    ben0x539 committed Apr 12, 2022
    Configuration menu
    Copy the full SHA
    ddacda1 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    c34dddb View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    d07500a View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    b7bba06 View commit details
    Browse the repository at this point in the history

Commits on Apr 14, 2022

  1. Configuration menu
    Copy the full SHA
    b544354 View commit details
    Browse the repository at this point in the history