Merge branch 'main' into rishadbaniya/gencat

Author: rishadbaniya

Cargo.lock

@@ -1,7 +1,15 @@
 [package]
-name = "m4"
+name = "posixutils-m4"
 version = "0.1.0"
 edition = "2021"
+description = "m4 - macro language processor"
+authors = ["Luke Frisken"]
+license = "MIT"
+repository = "https://github.com/rustcoreutils/posixutils-rs.git"
+
+[[bin]]
+name = "m4"
+path = "src/main.rs"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

m4/Cargo.toml

@@ -189,12 +189,12 @@ fn main() {
 //! using the following command:
 //! `cargo run -p m4-test-manager update-snapshots`
 use similar_asserts::assert_eq;
+use posixutils_m4::error::GetExitCode;
 use std::process::ExitStatus;
 use std::os::unix::ffi::OsStrExt;
 use std::os::unix::process::ExitStatusExt;
 use std::fs::read_to_string;
 use std::path::Path;
-use m4::error::GetExitCode;
 use m4_test_manager::TestSnapshot;
 
 fn init() {
@@ -256,11 +256,11 @@ fn run_command(input: &Path) -> std::process::Output {
 
             let stdout = StdoutRef::default();
             let mut stderr: Vec<u8> = Vec::new();
-            let args = m4::Args {
+            let args = posixutils_m4::Args {
                 files: vec![input.into()],
-                ..m4::Args::default()
+                ..posixutils_m4::Args::default()
             };
-            let result = m4::run(stdout.clone(), &mut stderr, args);
+            let result = posixutils_m4::run(stdout.clone(), &mut stderr, args);
             let status = ExitStatus::from_raw(result.get_exit_code() as i32);
             (stdout.into_inner(), stderr, status)
         }

m4/build.rs

@@ -51,6 +51,8 @@ impl ArgumentDefine {
     }
 }
 
+/// Define a symbol name to have some value [`DefineDirective::Define`] or NULL
+/// [`DefineDirective::Undefine`].
 #[derive(Debug, Clone)]
 pub enum DefineDirective {
     /// `name[=val]`
@@ -66,6 +68,7 @@ pub struct Args {
     /// Enable line synchronization output for the c99 preprocessor phase (that is, #line
     /// directives).
     pub line_synchronization: bool,
+    /// See [`DefineDirective`].
     pub define_directives: Vec<DefineDirective>,
     /// Whether to read input from a file.
     pub files: Vec<PathBuf>,
@@ -77,12 +80,14 @@ impl Args {
             .arg(
                 clap::Arg::new("line_synchronization")
                     .short('s')
+                    .help("Output line synchronization directives, suitable for cpp")
                     .action(clap::ArgAction::SetTrue),
             )
             .arg(
                 clap::Arg::new("define")
                     .short('D')
-                    .value_name("name[=val]")
+                    .value_name("name[=value]")
+                    .help("Define the symbol name to have some value (or NULL)")
                     .num_args(1)
                     .action(clap::ArgAction::Append),
             )

m4/src/lib.rs

@@ -1,14 +1,14 @@
 use std::process::ExitCode;
 
-use m4::error::GetExitCode;
+use posixutils_m4::error::GetExitCode;
 
 fn main() -> ExitCode {
     env_logger::init();
-    let args = m4::Args::parse();
+    let args = posixutils_m4::Args::parse();
 
     let stdout = std::io::stdout();
     let mut stderr = std::io::stderr();
-    if let Err(error) = m4::run(stdout, &mut stderr, args) {
+    if let Err(error) = posixutils_m4::run(stdout, &mut stderr, args) {
         ExitCode::from(u8::try_from(error.get_exit_code()).unwrap_or_else(|e| {
             eprintln!("Error casting exit code {e} into platform agnostic u8");
             1

m4/src/main.rs

@@ -2,8 +2,8 @@
 //! You can regenerate the tests (which are based on the fixtures in `fixtures/integration_tests/`)
 //! using the following command:
 //! `cargo run -p m4-test-manager update-snapshots`
-use m4::error::GetExitCode;
 use m4_test_manager::TestSnapshot;
+use posixutils_m4::error::GetExitCode;
 use similar_asserts::assert_eq;
 use std::fs::read_to_string;
 use std::os::unix::ffi::OsStrExt;
@@ -61,11 +61,11 @@ fn run_command(input: &Path) -> std::process::Output {
 
             let stdout = StdoutRef::default();
             let mut stderr: Vec<u8> = Vec::new();
-            let args = m4::Args {
+            let args = posixutils_m4::Args {
                 files: vec![input.into()],
-                ..m4::Args::default()
+                ..posixutils_m4::Args::default()
             };
-            let result = m4::run(stdout.clone(), &mut stderr, args);
+            let result = posixutils_m4::run(stdout.clone(), &mut stderr, args);
             let status = ExitStatus::from_raw(result.get_exit_code() as i32);
             (stdout.into_inner(), stderr, status)
         }