summaryrefslogtreecommitdiff
path: root/maint/check_doc_features
Commit message (Collapse)AuthorAgeFilesLines
* rtcompat: Add definitions for unix::SocketAddr.Nick Mathewson2024-09-241-0/+6
|
* tor-hsservice: Remove unnecessary docsrs cfg_attr.Gabriela Moldovan2024-08-071-1/+0
| | | | | The module is correctly documented as "only available on crate feature restricted-discovery" without it.
* maint/check_doc_features: Add restricted_discovery to additional_required.Gabriela Moldovan2024-08-061-0/+5
| | | | | The script isn't handling the `cfg_attr` on `pub mod restricted_discovery` very well, so we need to use the `additional_required` escape hatch.
* maint/check_doc_features: Include ; in end of item pattern.Gabriela Moldovan2024-08-061-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | This makes the script work on `cfg_attr`s applied to `mod` declarations ending in `;`. Without this change, the script fails with ``` processing tor-hsservice res += fn(os.path.join(dir_, file)) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/builds/nickm/arti/./maint/check_doc_features", line 112, in extract_cfg_attr end = min(subline.find(pat) for pat in ' (<' if subline.find(pat) !=-1) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ValueError: min() arg is an empty sequence ``` when run on code with `cfg_attr`s applied to `mod` declarations. Note: this change just improves the UX a bit, but doesn't actually fix the issue: the script still isn't able to handle `cfg_attr`'d `mod`s: it assumes all `#[cfg_attr(docsrs, ..)]` statements are applied to feature-gated `pub use`s, and if there aren't any (such as in the case of `cfg_attr`d modules, it assumes the feature gating is missing.
* Rename list_crates_publish to list_cratesIan Jackson2024-05-081-1/+1
|
* maint/check_doc_features: Use new list_crates_publish (nfc)Ian Jackson2024-05-081-2/+3
|
* Rename bucket-array-api feature to bucket-arrayNick Mathewson2024-05-071-1/+1
|
* Update check_doc_features for equix cfg(fuzzing) change.Nick Mathewson2024-05-071-1/+1
|
* equix/fuzz: CI and doc fixesMicah Elizabeth Scott2023-08-021-0/+5
| | | | | | | | The build found a stale private doc comment as well as an exception that needed to be made in check_doc_features. The check_doc_features change solidifies a decision that things marked with cfg(fuzzing) aren't part of the documented API.
* tor-proto: Add a suppression to "fix" the CIIan Jackson2023-07-121-0/+2
| | | | | | | This is failing in CI. I have no idea what the rules are and AFAICT no-one is alleging that there is an actual bug in the attributes. Empirically this suppression causes the script to pass.
* tor-rtcompat: Simplify trivial all() expressions.Nick Mathewson2023-07-061-2/+2
| | | | | | | Clippy nightly doesn't like `#[cfg(all(...))]` with only a single expression inside the `all(...)`. This requires an adjustment in check_doc_features.
* Fix a bug in check_doc_featuresNick Mathewson2023-02-211-7/+3
| | | | | | In Python, str.find returns -1 if it doesn't find the target character, and -1 is a true value. So `if pos := foo.find('c')` won't do what we want.
* tor-cell: documentation cleanups related to restricted_msgNick Mathewson2023-02-071-0/+5
|
* shell: use /usr/bin/env instead of absolute pathsEmil Engler2023-01-251-1/+1
| | | | | | | | | | This commit changes the shebang in all shell scripts from absolute paths (such as `/bin/bash` or `/usr/bin/python3`) to the `/usr/bin/env` binary with the accompanying interpreter as it's argument. The reason for this are as follows: - NixOS cannot work with absolute paths - BSD systems install their packages in /usr/local/bin
* fixup! tor-guardmgr: Fix visibility of TestConfig with no features enabledIan Jackson2022-11-181-1/+1
|
* docs features: Add a suppression for testingIan Jackson2022-11-031-0/+5
|
* Merge branch 'matrix-features' into 'main'Nick Mathewson2022-10-211-0/+2
|\ | | | | | | | | | | | | add checks for many feature combinations Closes #303 See merge request tpo/core/arti!775
| * fix doc-feature synchrotrinity-1686a2022-10-161-0/+2
| |
* | Remove now-needless check_doc_features exception.Nick Mathewson2022-10-201-6/+0
|/
* pt: Make PtTarget::push_setting fallible, and take IntoIan Jackson2022-10-031-1/+2
| | | | | | It has its own error type PtTargetInvalidSetting. In check_doc_features, adjust suppression to new code.
* pt: Try to fix docsrs problemIan Jackson2022-09-271-1/+1
|
* Rename various Transport* types to Pt*.Nick Mathewson2022-09-231-1/+1
| | | | | This clarifies that the types apply to pluggable transports only, and not (typically) to the default plain-old-TCP transport.
* New data types to describe transport targets.Nick Mathewson2022-09-231-0/+5
| | | | | I've tried to name and structure these for consistency, and comment reasonably well. We'll still probably want to make changes.
* switch from awk to pythontrinity-1686a2022-08-241-85/+134
|
* add feature annotation not added by doc_auto_cfgtrinity-1686a2022-08-241-0/+94