Commit graph

11 commits

Author SHA1 Message Date
Dale Mellor
d5c021e6c0 documentation: extensive editing of info manual after a note from Paul Vixie.
Paul has been in touch to say that the crontab format was not his invention,
and that his program was based off of V7's cron's functionality, not later
AT&T and Berkeley ones.

Thus the mcron manual is edited extensively to emphasise more the POSIX
standard crontab format, and to point out a more accurate history of cron
developments.

* doc/mcron.texi: small changes throughout the document.
2022-01-10 16:08:44 +00:00
Dale Mellor
172f70e6d2 documentation: Bug fix in a simple example.
The second example under the manual heading Simple Examples does not work.
The call to next-minute-from errs because the second argument must be a
list. It can’t be the raw number 15.

Thanks to Colton Lewis.

* doc/mcron.texi: edited text.
2021-09-03 12:33:35 +01:00
Dale Mellor
cb88cc9e42 doc/mcron.texi: Make the manual gender-neutral.
Replace his/hers with theirs, etc.

*doc/mcron.text: light edits only.
2020-04-20 16:49:05 +00:00
Adam Tack
ba2975649a doc: Fix “Every second Sunday” example
* doc/mcron.texi (Every second Sunday): If the first day of the month is
Sunday, then the second Sunday of the month is seven days later not
eight.
2019-02-11 09:38:11 +01:00
Mathieu Lirzin
ac39c00859
base: Add '<schedule>' record data type
Reifying the notion of a schedule helps reasoning about the code.
Passing a schedule as an argument to related procedures allows writing
simpler unit tests.

* src/mcron/base.scm(<schedule>): New record data type.
(make-schedule, schedule-user, set-schedule-user!)
(schedule-system, set-schedule-system!)
(schedule-current, set-schedule-current!): New procedures.
(system-job-list, user-job-list, configuration-source): Replace those
global variables with ...
(%global-schedule): ... this global <schedule> instance.
* src/mcron/base.scm (use-system-job-list, use-user-job-list)
(remove-user-jobs, clear-system-jobs, add-job, find-next-jobs)
(display-schedule, run-job-loop): Add '#:SCHEDULE' keyword argument.
* doc/mcron.texi (The base module): Update documentation.
2018-03-24 01:18:15 +01:00
Mathieu Lirzin
5f83aef90f
base: Add 'display-schedule' procedure
This procedure is a more generic and less coupled version of
'get-schedule' which has been kept for backward compatibility and
deprecated.

* src/mcron/base.scm (display-schedule): New procedure.
(get-schedule): Move to ...
* src/mcron/core.scm: ... here.
* src/mcron/scripts/cron.scm (main): Use 'display-schedule'.
* src/mcron/scripts/mcron.scm (main): Likewise.
* doc/mcron.texi (The base module): Document it.
2018-03-16 21:41:14 +01:00
Mathieu Lirzin
811ad9167a
doc: Use 'unless' form
* doc/mcron.texi (Invoking cron or crond): Use 'unless' form and put
"/etc/crontab" inside a @code command.
2017-09-28 18:13:08 +02:00
Mathieu Lirzin
31baff1a51 job-specifier: job: Add #:user keyword argument.
* src/mcron/job-specifier.scm (job): Add #:user keyword argument.
* doc/mcron.texi (Job specification): Document it.
2016-05-07 23:38:53 +02:00
Mathieu Lirzin
418b81e1af base: Rename (mcron core) module to (mcron base).
The 'configure' script deletes the 'core.*' files.  Having a file named
'base.scm' instead of 'core.scm' simplifies the build process without
changing the semantics.

* src/mcron/mcron-core.scm: Rename to ...
* src/mcron/base.scm: ... this.
All module users changed.
* Makefile.am (MODULES): Add 'src/mcron/base.scm'.
(CP): Remove variable.
(src/mcron/core.scm): Remove target.
(GEN_MODULES): Remove 'src/mcron/core.scm'.
(dist_mcronmodule_DATA): Remove 'src/mcron/mcron-core.scm'
* doc/mcron.texi: Adapt to name change.
* .gitignore: Update.
2016-05-07 23:38:53 +02:00
Mathieu Lirzin
940146bc90 doc: Include a copy of the GNU FDL.
* doc/fdl.texi: New file.
* doc/mcron.texi: Include it.
* makefile.am (doc_mcron_TEXINFOS): New variable.
2016-05-07 11:32:18 +02:00
Mathieu Lirzin
8f430594f4 build: Fix build of the manual.
* mcron.texinfo.in: Rename to ...
* doc/mcron.texi: ... this.
* doc/config.texi.in: New file.
* configure.ac: Adapt to it.
* makefile.am: Likewise.
* .gitignore: Likewise.
* README--git: Likewise.
2016-05-07 11:32:17 +02:00