itsscb/rust
1
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-10-04 19:28:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
rust/tests/rustdoc-gui
History
Nicholas Nethercote 121e87bf14 Remove rustc::existing_doc_keyword lint. 
`CheckAttrVisitor::check_doc_keyword` checks `#[doc(keyword = "..")]`
attributes to ensure they are on an empty module, and that the value is
a non-empty identifier.

The `rustc::existing_doc_keyword` lint checks these attributes to ensure
that the value is the name of a keyword.

It's silly to have two different checking mechanisms for these
attributes. This commit does the following.
- Changes `check_doc_keyword` to check that the value is the name of a
  keyword (avoiding the need for the identifier check, which removes a
  dependency on `rustc_lexer`).
- Removes the lint.
- Updates tests accordingly.

There is one hack: the `SelfTy` FIXME case used to used to be handled by
disabling the lint, but now is handled with a special case in
`is_doc_keyword`. That hack will go away if/when the FIXME is fixed.

Co-Authored-By: Guillaume Gomez <guillaume1.gomez@gmail.com>
2024-12-17 13:56:10 +11:00
..
src
Remove rustc::existing_doc_keyword lint.
2024-12-17 13:56:10 +11:00
anchor-navigable.goml
…
anchors.goml
rustdoc: make the header show all three buttons
2024-09-10 17:56:06 -07:00
basic-code.goml
rustdoc: use src consistently over source in code
2023-07-14 16:38:01 -07:00
check_info_sign_position.goml
…
check-code-blocks-margin.goml
…
check-stab-in-docblock.goml
Add GUI regression test for code in doc blocks
2024-10-26 15:45:17 +02:00
code-blocks-overflow.goml
…
code-color.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
code-example-buttons.goml
Simplify CSS but wrapping scraped example into a div and move the title out of the code block
2024-09-02 15:59:00 +02:00
code-sidebar-toggle.goml
rustdoc: clean up source sidebar hide button
2023-12-17 23:06:31 -07:00
code-tags.goml
rustdoc: rename /implementors to /impl.trait
2023-10-22 15:47:34 -07:00
codeblock-sub.goml
Migrate to 0.16.0 browser-ui-test version
2023-05-11 11:34:22 +02:00
codeblock-tooltip.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
copy-code.goml
Update GUI tests for code example buttons
2024-08-05 11:04:51 +02:00
copy-path.goml
Add GUI test for copy path button
2024-04-17 16:56:14 +02:00
cursor.goml
Update to new browser-ui-test version
2024-04-01 22:25:01 +02:00
default-settings.goml
Migrate GUI colors test to original CSS color format
2023-09-23 20:03:03 +02:00
deref-block.goml
Update GUI tests for documentation indent changes
2024-11-12 17:58:10 +01:00
docblock-big-code-mobile.goml
Update GUI test
2024-10-26 20:40:59 +02:00
docblock-code-block-line-number.goml
Make use of wait-for*-false commands
2024-09-28 18:04:00 +02:00
docblock-details.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
docblock-table-overflow.goml
Update GUI test after rebase
2024-12-05 22:50:21 +01:00
docblock-table.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
duplicate-macro-reexport.goml
rustdoc: use <wbr>-tolerant function to check text contents
2024-07-29 08:46:11 -07:00
enum-variants.goml
…
escape-key.goml
Update to new browser-ui-test version
2024-04-01 22:25:01 +02:00
extend-css.goml
…
fields.goml
Add GUI regression test for variant structfields margins
2024-10-28 11:16:38 +01:00
font-weight.goml
rustdoc: use <wbr>-tolerant function to check text contents
2024-07-29 08:46:11 -07:00
globals.goml
Update to new browser-ui-test version
2024-04-01 22:25:01 +02:00
go-to-collapsed-elem.goml
Update to new browser-ui-test version
2024-04-01 22:25:01 +02:00
hash-item-expansion.goml
…
headers-color.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
headings-anchor.goml
Update to new browser-ui-test version
2024-04-01 22:25:01 +02:00
headings.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
help-page.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
hide-mobile-topbar.goml
rustdoc: allow resizing the sidebar
2023-10-11 10:26:36 -07:00
highlight-colors.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
huge-collection-of-constants.goml
…
huge-logo.goml
rustdoc: add test cases for mile wide bar
2024-07-16 13:29:35 -07:00
impl_on_foreign_order.goml
Add GUI test to ensure that implementations on foreign types are in the expected order
2023-11-02 18:02:14 +01:00
impl-block-doc.goml
Improve positioning of "..." in collapsed impl block
2024-12-05 22:50:21 +01:00
impl-default-expansion.goml
…
impl-doc.goml
Update GUI tests
2024-12-05 22:50:21 +01:00
implementors.goml
…
item-decl-colors.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
item-decl-comment-highlighting.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
item-info-alignment.goml
Update GUI tests for documentation indent changes
2024-11-12 17:58:10 +01:00
item-info-overflow.goml
Update GUI tests
2024-12-05 22:50:21 +01:00
item-info.goml
Align impl doc block with impl keyword
2024-11-13 15:13:31 +01:00
item-name-wrap.goml
Add regression test for items list size (#128023)
2024-07-22 11:33:03 +02:00
item-summary-table.goml
…
javascript-disabled.goml
rustdoc: dedup search form HTML
2024-05-05 08:15:08 -07:00
jump-to-def-background.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
label-next-to-symbol.goml
rustdoc: properly handle path wrapping
2024-07-29 10:31:02 -07:00
links-color.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
list_code_block.goml
…
list-margins.goml
Add GUI regression test for #130622 and for #131223
2024-10-04 18:01:52 +02:00
method-margins.goml
…
methods-left-margin.goml
Update GUI tests for documentation indent changes
2024-11-12 17:58:10 +01:00
mobile-crate-name.goml
Add regression test for #120471 to ensure that long crate name are handled as expected on mobile
2024-01-31 16:40:23 +01:00
mobile.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
module-items-font.goml
…
no-docblock.goml
rustdoc: rename /implementors to /impl.trait
2023-10-22 15:47:34 -07:00
notable-trait.goml
Align impl doc block with impl keyword
2024-11-13 15:13:31 +01:00
overflow-tooltip-information.goml
…
pocket-menu.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
README.md
Enable --no-sandbox option by default for rustdoc GUI tests
2024-10-04 12:11:23 +02:00
rust-logo.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
scrape-examples-button-focus.goml
Fix wrong padding for expanded scraped example
2024-09-03 01:04:59 +02:00
scrape-examples-color.goml
Simplify CSS but wrapping scraped example into a div and move the title out of the code block
2024-09-02 15:59:00 +02:00
scrape-examples-fonts.goml
…
scrape-examples-layout.goml
rustdoc: adjust spacing and typography in header
2024-10-23 19:15:23 -04:00
scrape-examples-toggle.goml
Make theme switching closer to reality
2024-04-08 12:14:41 +02:00
search-about-this-result.goml
rustdoc-search: simplify rules for generics and type params
2024-10-30 12:27:48 -07:00
search-corrections.goml
rustdoc-search: pass original names through AST
2024-10-30 10:35:38 -07:00
search-error.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
search-filter.goml
rustdoc: make the header show all three buttons
2024-09-10 17:56:06 -07:00
search-form-elements.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
search-input-mobile.goml
…
search-keyboard.goml
Update to new browser-ui-test version
2024-04-01 22:25:01 +02:00
search-no-result.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
search-reexport.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
search-result-color.goml
Remove rustc::existing_doc_keyword lint.
2024-12-17 13:56:10 +11:00
search-result-description.goml
…
search-result-display.goml
rustdoc-gui: fix test cases
2024-09-29 10:02:06 -07:00
search-result-go-to-first.goml
Tweak breadcrumbs list
2024-09-23 09:21:39 -07:00
search-result-impl-disambiguation.goml
rustdoc-search: account for numeric disambiguators on impls
2024-08-06 07:36:12 -07:00
search-result-keyword.goml
Remove rustc::existing_doc_keyword lint.
2024-12-17 13:56:10 +11:00
search-tab-change-title-fn-sig.goml
Update to new browser-ui-test version
2024-04-01 22:25:01 +02:00
search-tab.goml
Remove rustc::existing_doc_keyword lint.
2024-12-17 13:56:10 +11:00
search-title.goml
Add rustdoc GUI test to check title with and without search
2024-07-27 12:12:16 +02:00
setting-auto-hide-content-large-items.goml
Update to new browser-ui-test version
2024-04-01 22:25:01 +02:00
setting-auto-hide-item-methods-docs.goml
Update to new browser-ui-test version
2024-04-01 22:25:01 +02:00
setting-auto-hide-trait-implementations.goml
Update to new browser-ui-test version
2024-04-01 22:25:01 +02:00
setting-go-to-only-result.goml
Update to new browser-ui-test version
2024-04-01 22:25:01 +02:00
settings-button.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
settings.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
shortcuts.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
sidebar-links-color.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
sidebar-macro-reexport.goml
rustdoc: use <wbr>-tolerant function to check text contents
2024-07-29 08:46:11 -07:00
sidebar-mobile-scroll.goml
…
sidebar-mobile.goml
rustdoc: use <wbr>-tolerant function to check text contents
2024-07-29 08:46:11 -07:00
sidebar-modnav-position.goml
rustdoc: add test case for modnav position when TOC is off
2024-08-20 16:54:04 -07:00
sidebar-resize-close-popover.goml
rustdoc: hide modals when resizing the sidebar
2024-01-08 09:54:05 -07:00
sidebar-resize-setting.goml
Fix corner cases when dealing with mobile mode
2023-12-19 19:50:53 -07:00
sidebar-resize-window.goml
rustdoc: fix resize trouble with mobile
2023-10-11 12:15:33 -07:00
sidebar-resize.goml
rustdoc: allow resizing the sidebar
2023-10-11 10:26:36 -07:00
sidebar-source-code-display.goml
rustdoc: adjust spacing and typography in header
2024-10-23 19:15:23 -04:00
sidebar-source-code.goml
rustdoc: use <wbr>-tolerant function to check text contents
2024-07-29 08:46:11 -07:00
sidebar.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
source-anchor-scroll.goml
rustdoc: adjust spacing and typography in header
2024-10-23 19:15:23 -04:00
source-code-page-code-scroll.goml
Improve positioning of "..." in collapsed impl block
2024-12-05 22:50:21 +01:00
source-code-page.goml
rustdoc: adjust spacing and typography in header
2024-10-23 19:15:23 -04:00
src-font-size.goml
rustdoc: use src consistently over source in code
2023-07-14 16:38:01 -07:00
stab-badge.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
stab-in-doc.goml
Add regression test for stab display in doc blocks
2024-07-21 11:52:24 +02:00
struct-fields.goml
Add GUI regression test for doc struct fields margins
2024-10-27 11:26:45 +01:00
target.goml
rustdoc: animate the :target highlight
2024-08-19 18:14:35 -07:00
theme-change.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
theme-defaults.goml
…
theme-in-history.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
toggle-click-deadspace.goml
Tweak breadcrumbs list
2024-09-23 09:21:39 -07:00
toggle-docs-mobile.goml
Update GUI tests for documentation indent changes
2024-11-12 17:58:10 +01:00
toggle-docs.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
toggle-implementors.goml
…
toggled-open-implementations.goml
…
tooltip-over-sidebar.goml
rustdoc ui: adjust tooltip z-index to be above sidebar
2023-12-31 20:31:56 +01:00
trait-sidebar-item-order.goml
rustdoc: rename /implementors to /impl.trait
2023-10-22 15:47:34 -07:00
trait-with-bounds.goml
Add GUI test for trait bounds display
2024-07-19 21:31:30 +02:00
type-declation-overflow.goml
rustdoc: redesign toolbar and disclosure widgets
2024-09-10 17:56:05 -07:00
type-impls.goml
rustdoc: make JS trait impls act more like HTML
2023-10-22 16:51:32 -07:00
unsafe-fn.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
utils.goml
Make theme switching closer to reality
2024-04-08 12:14:41 +02:00
warning-block.goml
Use include command to reduce code duplication
2024-04-05 21:38:55 +02:00
where-whitespace.goml
Update to new browser-ui-test version
2024-04-01 22:25:01 +02:00

README.md

The tests present here are used to test the generated HTML from rustdoc. The goal is to prevent unsound/unexpected GUI changes.

This is using the browser-ui-test framework to do so. It works as follows:

It wraps puppeteer to send commands to a web browser in order to navigate and test what's being currently displayed in the web page.

You can find more information and its documentation in its repository.

If you need to have more information on the tests run, you can use --test-args:

$ ./x.py test tests/rustdoc-gui --stage 1 --test-args --debug

If you don't want to run in headless mode (helpful to debug sometimes), you can use --no-headless:

$ ./x.py test tests/rustdoc-gui --stage 1 --test-args --no-headless

To see the supported options, use --help.