diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-18 02:49:42 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-18 02:49:42 +0000 |
commit | 837b550238aa671a591ccf282dddeab29cadb206 (patch) | |
tree | 914b6b8862bace72bd3245ca184d374b08d8a672 /vendor/scratch | |
parent | Adding debian version 1.70.0+dfsg2-1. (diff) | |
download | rustc-837b550238aa671a591ccf282dddeab29cadb206.tar.xz rustc-837b550238aa671a591ccf282dddeab29cadb206.zip |
Merging upstream version 1.71.1+dfsg1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/scratch')
-rw-r--r-- | vendor/scratch/.cargo-checksum.json | 1 | ||||
-rw-r--r-- | vendor/scratch/Cargo.toml | 36 | ||||
-rw-r--r-- | vendor/scratch/LICENSE-APACHE | 176 | ||||
-rw-r--r-- | vendor/scratch/LICENSE-MIT | 23 | ||||
-rw-r--r-- | vendor/scratch/README.md | 127 | ||||
-rw-r--r-- | vendor/scratch/build.rs | 13 | ||||
-rw-r--r-- | vendor/scratch/src/lib.rs | 132 |
7 files changed, 508 insertions, 0 deletions
diff --git a/vendor/scratch/.cargo-checksum.json b/vendor/scratch/.cargo-checksum.json new file mode 100644 index 000000000..1c637dff4 --- /dev/null +++ b/vendor/scratch/.cargo-checksum.json @@ -0,0 +1 @@ +{"files":{"Cargo.toml":"e562ec51af2209da253b31e24a5809860d6dca7af6afaa4aa3b76aa2f0fbb8ce","LICENSE-APACHE":"62c7a1e35f56406896d7aa7ca52d0cc0d272ac022b5d2796e7d6905db8a3636a","LICENSE-MIT":"23f18e03dc49df91622fe2a76176497404e46ced8a715d9d2b67a7446571cca3","README.md":"68e59e1c3a8531d34b39d5b252715d7202d363ef8763e2a342d0b565169c5f2c","build.rs":"8cdb2dbbced05e5d1e840f5df9120eff79dc200f85e9e6c6dae2e5ec82ef1eb9","src/lib.rs":"568b076a0601866c8548723975fcfb17e46b2a3926b94fc0e6c50e75550cc3f8"},"package":"1792db035ce95be60c3f8853017b3999209281c24e2ba5bc8e59bf97a0c590c1"}
\ No newline at end of file diff --git a/vendor/scratch/Cargo.toml b/vendor/scratch/Cargo.toml new file mode 100644 index 000000000..dfee61b3a --- /dev/null +++ b/vendor/scratch/Cargo.toml @@ -0,0 +1,36 @@ +# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO +# +# When uploading crates to the registry Cargo will automatically +# "normalize" Cargo.toml files for maximal compatibility +# with all versions of Cargo and also rewrite `path` dependencies +# to registry (e.g., crates.io) dependencies. +# +# If you are reading this file be aware that the original Cargo.toml +# will likely look very different (and much more reasonable). +# See Cargo.toml.orig for the original contents. + +[package] +rust-version = "1.0" +name = "scratch" +version = "1.0.5" +authors = ["David Tolnay <dtolnay@gmail.com>"] +build = "build.rs" +description = "Compile-time temporary directory shared by multiple crates and erased by `cargo clean`" +documentation = "https://docs.rs/scratch" +readme = "README.md" +categories = [ + "development-tools::build-utils", + "filesystem", +] +license = "MIT OR Apache-2.0" +repository = "https://github.com/dtolnay/scratch" + +[package.metadata.docs.rs] +targets = ["x86_64-unknown-linux-gnu"] + +[lib] +name = "scratch" +doc-scrape-examples = false + +[dev-dependencies.fs2] +version = "0.4" diff --git a/vendor/scratch/LICENSE-APACHE b/vendor/scratch/LICENSE-APACHE new file mode 100644 index 000000000..1b5ec8b78 --- /dev/null +++ b/vendor/scratch/LICENSE-APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS diff --git a/vendor/scratch/LICENSE-MIT b/vendor/scratch/LICENSE-MIT new file mode 100644 index 000000000..31aa79387 --- /dev/null +++ b/vendor/scratch/LICENSE-MIT @@ -0,0 +1,23 @@ +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/vendor/scratch/README.md b/vendor/scratch/README.md new file mode 100644 index 000000000..5d7ba7a72 --- /dev/null +++ b/vendor/scratch/README.md @@ -0,0 +1,127 @@ +Shared scratch for build scripts +================================ + +[<img alt="github" src="https://img.shields.io/badge/github-dtolnay/scratch-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/dtolnay/scratch) +[<img alt="crates.io" src="https://img.shields.io/crates/v/scratch.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/scratch) +[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-scratch-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/scratch) +[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/dtolnay/scratch/ci.yml?branch=master&style=for-the-badge" height="20">](https://github.com/dtolnay/scratch/actions?query=branch%3Amaster) + +This crate exposes a compile-time temporary directory sharable by multiple +crates in a build graph and erased by `cargo clean`. + +The intended usage is from a build.rs Cargo build script, or more likely from a +library which is called by other crates' build scripts. + +```toml +# Cargo.toml + +[build-dependencies] +scratch = "1.0" +``` + +```rust +// build.rs + +fn main() { + let dir = scratch::path("mycrate"); + // ... write or read inside of that path +} +``` + +<br> + +## Comparisons + +Comparison to **`std::env::var_os("OUT_DIR")`**: + +- This functionality is different from OUT\_DIR in that the same directory path + will be seen by *all* crates whose build passes a matching `suffix` argument, + and each crate can see content placed into the directory by those other + crates' build scripts that have already run. + +- This functionality is similar to OUT\_DIR in that both are erased when a + `cargo clean` is executed. + +Comparison to **`std::env::temp_dir()`**: + +- This functionality is similar to temp\_dir() in that stuff that goes in is + visible to subsequently running build scripts. + +- This functionality is different from temp\_dir() in that `cargo clean` cleans + up the contents. + +<br> + +## Tips + +You'll want to consider what happens when Cargo runs multiple build scripts +concurrently that access the same scratch dir. In some use cases you likely want +some synchronization over the contents of the scratch directory, such as by an +advisory [file lock]. On Unix-like and Windows host systems the simplest way to +sequence the build scripts such that each one gets exclusive access one after +the other is something like: + +[file lock]: https://man7.org/linux/man-pages/man2/flock.2.html + +```rust +use std::fs::File; +use std::io; + +fn main() -> io::Result<()> { + let dir = scratch::path("demo"); + let flock = File::create(dir.join(".lock"))?; + fs2::FileExt::lock_exclusive(&flock)?; + + // ... now do work +} +``` + +This simplest approach is fine for a cache which is slow to fill (maybe a large +download) but fast/almost immediate to use. On the other hand if the build +scripts using your cache will take a while to complete even if they only read +from the scratch directory, a different approach which allows readers to make +progress in parallel would perform better. + +```rust +use std::fs::{self, File}; +use std::io; + +fn main() -> io::Result<()> { + let dir = scratch::path("demo"); + let flock = File::create(dir.join(".lock"))?; + let sdk = dir.join("thing.sdk"); + + if !sdk.exists() { + fs2::FileExt::lock_exclusive(&flock)?; + if !sdk.exists() { + let download_location = sdk.with_file_name("thing.sdk.partial"); + download_sdk_to(&download_location)?; + fs::rename(&download_location, &sdk)?; + } + fs2::FileExt::unlock(&flock)?; + } + + // ... now use the SDK +} +``` + +For use cases that are not just a matter of the first build script writing to +the directory and the rest reading, more elaborate schemes involving +`lock_shared` might be something to consider. + +<br> + +#### License + +<sup> +Licensed under either of <a href="LICENSE-APACHE">Apache License, Version +2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option. +</sup> + +<br> + +<sub> +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in this crate by you, as defined in the Apache-2.0 license, shall +be dual licensed as above, without any additional terms or conditions. +</sub> diff --git a/vendor/scratch/build.rs b/vendor/scratch/build.rs new file mode 100644 index 000000000..a854765e5 --- /dev/null +++ b/vendor/scratch/build.rs @@ -0,0 +1,13 @@ +#![cfg_attr(feature = "cargo-clippy", allow(renamed_and_removed_lints))] +#![cfg_attr( + feature = "cargo-clippy", + allow(let_underscore_drop, let_underscore_untyped) +)] + +use std::{env, fs}; + +fn main() { + let out_dir = env::var_os("OUT_DIR").unwrap(); + let _ = fs::remove_dir_all(&out_dir); + let _ = fs::create_dir(&out_dir); +} diff --git a/vendor/scratch/src/lib.rs b/vendor/scratch/src/lib.rs new file mode 100644 index 000000000..a384ae441 --- /dev/null +++ b/vendor/scratch/src/lib.rs @@ -0,0 +1,132 @@ +//! This crate exposes a compile-time temporary directory sharable by multiple +//! crates in a build graph and erased by `cargo clean`. +//! +//! The intended usage is from a build.rs Cargo build script, or more likely +//! from a library which is called by other crates' build scripts. +//! +//! ```toml +//! # Cargo.toml +//! +//! [build-dependencies] +//! scratch = "1.0" +//! ``` +//! +//! ``` +//! // build.rs +//! +//! fn main() { +//! let dir = scratch::path("mycrate"); +//! // ... write or read inside of that path +//! } +//! ``` +//! +//! <br> +//! +//! # Comparisons +//! +//! Comparison to **`std::env::var_os("OUT_DIR")`**: +//! +//! - This functionality is different from OUT_DIR in that the same directory +//! path will be seen by *all* crates whose build passes a matching `suffix` +//! argument, and each crate can see content placed into the directory by +//! those other crates' build scripts that have already run. +//! +//! - This functionality is similar to OUT_DIR in that both are erased when a +//! `cargo clean` is executed. +//! +//! Comparison to **`std::env::temp_dir()`**: +//! +//! - This functionality is similar to temp_dir() in that stuff that goes in is +//! visible to subsequently running build scripts. +//! +//! - This functionality is different from temp_dir() in that `cargo clean` +//! cleans up the contents. +//! +//! <br> +//! +//! # Tips +//! +//! You'll want to consider what happens when Cargo runs multiple build scripts +//! concurrently that access the same scratch dir. In some use cases you likely +//! want some synchronization over the contents of the scratch directory, such +//! as by an advisory [file lock]. On Unix-like and Windows host systems the +//! simplest way to sequence the build scripts such that each one gets exclusive +//! access one after the other is something like: +//! +//! [file lock]: https://man7.org/linux/man-pages/man2/flock.2.html +//! +//! ```edition2018 +//! use std::fs::File; +//! use std::io; +//! +//! fn main() -> io::Result<()> { +//! let dir = scratch::path("demo"); +//! let flock = File::create(dir.join(".lock"))?; +//! fs2::FileExt::lock_exclusive(&flock)?; +//! +//! // ... now do work +//! # Ok(()) +//! } +//! ``` +//! +//! This simplest approach is fine for a cache which is slow to fill (maybe a +//! large download) but fast/almost immediate to use. On the other hand if the +//! build scripts using your cache will take a while to complete even if they +//! only read from the scratch directory, a different approach which allows +//! readers to make progress in parallel would perform better. +//! +//! ```edition2018 +//! use std::fs::{self, File}; +//! use std::io; +//! +//! fn main() -> io::Result<()> { +//! let dir = scratch::path("demo"); +//! let flock = File::create(dir.join(".lock"))?; +//! let sdk = dir.join("thing.sdk"); +//! +//! if !sdk.exists() { +//! fs2::FileExt::lock_exclusive(&flock)?; +//! if !sdk.exists() { +//! let download_location = sdk.with_file_name("thing.sdk.partial"); +//! download_sdk_to(&download_location)?; +//! fs::rename(&download_location, &sdk)?; +//! } +//! fs2::FileExt::unlock(&flock)?; +//! } +//! +//! // ... now use the SDK +//! # Ok(()) +//! } +//! # +//! # use std::path::Path; +//! # +//! # fn download_sdk_to(location: &Path) -> io::Result<()> { +//! # fs::write(location, "...") +//! # } +//! ``` +//! +//! For use cases that are not just a matter of the first build script writing +//! to the directory and the rest reading, more elaborate schemes involving +//! `lock_shared` might be something to consider. + +#![doc(html_root_url = "https://docs.rs/scratch/1.0.5")] +#![cfg_attr(feature = "cargo-clippy", allow(renamed_and_removed_lints))] +#![cfg_attr( + feature = "cargo-clippy", + allow( + doc_markdown, + let_underscore_drop, + let_underscore_untyped, + must_use_candidate, + needless_doctest_main + ) +)] + +use std::fs; +use std::path::{Path, PathBuf}; + +pub fn path(suffix: &str) -> PathBuf { + let p = Path::new(env!("OUT_DIR")).join(suffix); + let _ = fs::create_dir(&p); + p +} |