From 022ced26007050286ae45001d8a57233c2e39dc3 Mon Sep 17 00:00:00 2001 From: MEO265 <99362508+MEO265@users.noreply.github.com> Date: Fri, 23 Jan 2026 22:42:56 +0100 Subject: [PATCH] Remove dev version number from NEWS --- DESCRIPTION | 2 +- NEWS.md | 5 +++++ R/run_open_wbo.R | 22 ++++++++++++++++------ man/run_open_wbo.Rd | 20 +++++++++++++++----- 4 files changed, 37 insertions(+), 12 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 4cc7a1c..14afc91 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: Rwbo Title: Run the 'Open-WBO' MaxSAT Solver -Version: 0.1.2 +Version: 0.1.2.9000 Authors@R: c( person("Matthias", "Ollech", email = "ollech@gmx.com", role = c("aut", "cre")), person("Ruben Martins, Vasco Manquinho, Ines Lynce", role = "cph", diff --git a/NEWS.md b/NEWS.md index 38dfaaf..acba346 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,8 @@ +# Rwbo (Development Version) + +* Update documentation to refer to open-wbo and clarify the bundled executable + naming and static-linking limitations. + # Rwbo 0.1.2 * Build without `gmpxx.h` by default. diff --git a/R/run_open_wbo.R b/R/run_open_wbo.R index 5ced737..dcbd84d 100644 --- a/R/run_open_wbo.R +++ b/R/run_open_wbo.R @@ -1,22 +1,32 @@ -#' Run open-wbo_static +#' Run open-wbo #' -#' Run the bundled `open-wbo_static` binary with user-supplied parameters. +#' Run the bundled `open-wbo` binary with user-supplied parameters. #' #' @details -#' `args` is passed directly to the `open-wbo_static` command-line tool, so supply +#' `args` is passed directly to the `open-wbo` command-line tool, so supply #' the path to a WCNF file along with any solver flags you want to enable. To see #' the full list of supported options for your bundled binary, run #' `run_open_wbo("--help")`. The help text is emitted on stderr, so it appears in #' your console but is not returned by `run_open_wbo()`. #' +#' The executable bundled with the package is named `open-wbo_static` (or +#' `open-wbo_static.exe` on Windows). The build aims to be as static as the +#' platform allows: non-Darwin builds attempt to use the static target, but they +#' fall back to the release binary when a static build is unavailable. macOS +#' builds always use the release binary, because the Apple toolchain does not +#' provide fully static system libraries (the `libSystem` umbrella is only +#' available dynamically), and static linking of system frameworks is not +#' supported. As a result, some system libraries remain dynamically linked and a +#' 100% static build is not guaranteed. +#' #' Common solver options include toggles such as `-forceunsat`/`-no-forceunsat`, #' `-adapt`/`-no-adapt`, `-print-model`/`-no-print-model`, and parameter settings #' like `-algorithm `, `-cpu-lim `, `-mem-lim `, and #' `-verbosity `. #' -#' @param args Character vector of arguments passed to `open-wbo_static`. +#' @param args Character vector of arguments passed to `open-wbo`. #' -#' @return Character string containing the output from `open-wbo_static`. +#' @return Character string containing the output from `open-wbo`. #' #' @examples #' \donttest{ @@ -43,7 +53,7 @@ run_open_wbo <- function(args = character()) { stop("open-wbo_static not found. Please reinstall Rwbo.", call. = FALSE) } - # open-wbo_static uses non-zero exit statuses (20 for UNSAT, 30 for OPTIMUM). + # open-wbo uses non-zero exit statuses (20 for UNSAT, 30 for OPTIMUM). output <- suppressWarnings(system2( bin_path, args = args, diff --git a/man/run_open_wbo.Rd b/man/run_open_wbo.Rd index d3dbdde..d90a6f7 100644 --- a/man/run_open_wbo.Rd +++ b/man/run_open_wbo.Rd @@ -2,26 +2,36 @@ % Please edit documentation in R/run_open_wbo.R \name{run_open_wbo} \alias{run_open_wbo} -\title{Run open-wbo_static} +\title{Run open-wbo} \usage{ run_open_wbo(args = character()) } \arguments{ -\item{args}{Character vector of arguments passed to `open-wbo_static`.} +\item{args}{Character vector of arguments passed to `open-wbo`.} } \value{ -Character string containing the output from `open-wbo_static`. +Character string containing the output from `open-wbo`. } \description{ -Run the bundled `open-wbo_static` binary with user-supplied parameters. +Run the bundled `open-wbo` binary with user-supplied parameters. } \details{ -`args` is passed directly to the `open-wbo_static` command-line tool, so supply +`args` is passed directly to the `open-wbo` command-line tool, so supply the path to a WCNF file along with any solver flags you want to enable. To see the full list of supported options for your bundled binary, run `run_open_wbo("--help")`. The help text is emitted on stderr, so it appears in your console but is not returned by `run_open_wbo()`. +The executable bundled with the package is named `open-wbo_static` (or +`open-wbo_static.exe` on Windows). The build aims to be as static as the +platform allows: non-Darwin builds attempt to use the static target, but they +fall back to the release binary when a static build is unavailable. macOS +builds always use the release binary, because the Apple toolchain does not +provide fully static system libraries (the `libSystem` umbrella is only +available dynamically), and static linking of system frameworks is not +supported. As a result, some system libraries remain dynamically linked and a +100% static build is not guaranteed. + Common solver options include toggles such as `-forceunsat`/`-no-forceunsat`, `-adapt`/`-no-adapt`, `-print-model`/`-no-print-model`, and parameter settings like `-algorithm `, `-cpu-lim `, `-mem-lim `, and