nordic-dev.net/nixpkgs
nordic-dev.net/nixpkgs
2
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-26 08:53:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

tests.nixpkgs-check-by-name: Minor doc updates

Browse Source
This commit is contained in:
Silvan Mosberger 2023-10-24 00:20:32 +02:00
parent 8be41ace99
commit 03c58ad1d6
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pkgs/test/nixpkgs-check-by-name/README.md
View File

@ -1,6 +1,6 @@
# Nixpkgs pkgs/by-name checker # Nixpkgs pkgs/by-name checker
This directory implements a program to check the [validity](#validity-checks) of the `pkgs/by-name` Nixpkgs directory once introduced. This directory implements a program to check the [validity](#validity-checks) of the `pkgs/by-name` Nixpkgs directory.
It is being used by [this GitHub Actions workflow](../../../.github/workflows/check-by-name.yml). It is being used by [this GitHub Actions workflow](../../../.github/workflows/check-by-name.yml).
This is part of the implementation of [RFC 140](https://github.com/NixOS/rfcs/pull/140). This is part of the implementation of [RFC 140](https://github.com/NixOS/rfcs/pull/140).
@ -24,7 +24,7 @@ This API may be changed over time if the CI workflow making use of it is adjuste
- `2`: If an unexpected I/O error occurs - `2`: If an unexpected I/O error occurs
- Standard error: - Standard error:
- Informative messages - Informative messages
- Error messages if validation is not successful - Detected problems if validation is not successful
## Validity checks ## Validity checks

4
pkgs/test/nixpkgs-check-by-name/src/main.rs
View File

@ -68,8 +68,8 @@ fn main() -> ExitCode {
/// ///
/// # Return value /// # Return value
/// - `Err(e)` if an I/O-related error `e` occurred. /// - `Err(e)` if an I/O-related error `e` occurred.
/// - `Ok(false)` if the structure is invalid, all the structural errors have been written to `error_writer`. /// - `Ok(false)` if there are problems, all of which will be written to `error_writer`.
/// - `Ok(true)` if the structure is valid, nothing will have been written to `error_writer`. /// - `Ok(true)` if there are no problems
pub fn check_nixpkgs<W: io::Write>( pub fn check_nixpkgs<W: io::Write>(
nixpkgs_path: &Path, nixpkgs_path: &Path,
version: Version, version: Version,