Save roxygen version in description.

Fixes #338
r-lib · Oct 6, 2015 · cbbf8c7 · krlmlr · Oct 6, 2015 · hadley
1 parent c0f9c95
commit cbbf8c7
Show file tree

Hide file tree

Showing 17 changed files with 32 additions and 15 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -59,3 +59,4 @@ Collate:
     'usage.R'
     'util-locale.R'
     'utils.R'
+RoxygenNote: 4.1.1.9000
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,4 +1,4 @@
-# Generated by roxygen2 (4.1.1.9000): do not edit by hand
+# Generated by roxygen2: do not edit by hand
 
 S3method(c,rd)
 S3method(clean,had)

diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,8 @@
 # roxygen2 4.1.1.9000
 
+* Roxygen now records its version in a single place: the `RoxygenNote`
+  field in the `DESCRIPTION` (#338).
+
 * `\usage{}` is correctly generated for functions with string arguments 
   containing `"\""` (#265).
 

diff --git a/R/roxygenize.R b/R/roxygenize.R
@@ -40,6 +40,7 @@ roxygenize <- function(package.dir = ".",
   base_path <- normalizePath(package.dir)
   man_path <- file.path(base_path, "man")
   dir.create(man_path, recursive = TRUE, showWarnings = FALSE)
+  update_roxygen_version(base_path)
 
   options <- load_options(base_path)
   roclets <- roclets %||% options$roclets

diff --git a/R/safety.R b/R/safety.R
@@ -33,6 +33,18 @@ check_made_by <- function(first) {
 }
 
 made_by <- function(comment) {
-  paste0(comment, " Generated by roxygen2 (", packageVersion("roxygen2"),
-    "): do not edit by hand\n")
+  paste0(comment, " Generated by roxygen2: do not edit by hand\n")
+}
+
+update_roxygen_version <- function(base_path) {
+  desc_path <- file.path(base_path, "DESCRIPTION")
+  old <- read.description(desc_path)
+
+  new <- old
+  new$RoxygenNote <- packageVersion("roxygen2")
+
+  if (!identical(old, new)) {
+    cat('Updating roxygen version in ', desc_path, "\n")
+    write.description(new, desc_path)
+  }
 }
diff --git a/man/is_s3_generic.Rd b/man/is_s3_generic.Rd
diff --git a/man/namespace_roclet.Rd b/man/namespace_roclet.Rd
diff --git a/man/new_roclet.Rd b/man/new_roclet.Rd
diff --git a/man/object.Rd b/man/object.Rd
diff --git a/man/rd_roclet.Rd b/man/rd_roclet.Rd
diff --git a/man/register-parser.Rd b/man/register-parser.Rd
diff --git a/man/roc_proc_text.Rd b/man/roc_proc_text.Rd
diff --git a/man/roxygen.Rd b/man/roxygen.Rd
diff --git a/man/roxygenize.Rd b/man/roxygenize.Rd
diff --git a/man/source_package.Rd b/man/source_package.Rd
diff --git a/man/update_collate.Rd b/man/update_collate.Rd
diff --git a/man/vignette_roclet.Rd b/man/vignette_roclet.Rd