Workflows [FreeBSD WIKI]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Workflows ======

I'd like to improve the way %%FreeBSD%% is developed and maintained. This wiki page is a scratch pad I use to take notes. I'll try to add more details in the future.

===== Examples =====

Examples of issues, which are the result of not having workflows:

  * https://svnweb.freebsd.org/changeset/base/335498
  * https://svnweb.freebsd.org/ports?view=rev&rev=472972
    * Solution: a request to check if the patches are still needed.
  * [[https://svnweb.freebsd.org/ports?view=revision&revision=472971|Replace ${service}_user with ${service}_xxxuser in an rc script as ${service}_user has a special meaning in the rc framework]]
    * Solution: a check making sure that the service script is using this feature of the rc framework. The check should be possible to disable.
  * https://svnweb.freebsd.org/base?view=revision&revision=335073
  * [[https://svnweb.freebsd.org/base?view=revision&revision=335607|Manual page out of sync]]
  * [[https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=209169|Periodic clean-up of the commercial vendors list]]

Examples of why we might want to be able to set up workflows for to-be-created features:

  * [[https://lists.freebsd.org/pipermail/freebsd-current/2018-June/069915.html|The need for a manual page for a tool yet to be fully ported.]]

===== Ideas =====

  * Pre- or post-commit hooks:
    * //Document: yes|no//
    * //Needs documenting: yes|no//
    * Trigger, which checks if a manual page is changed if a source file is changed.
  * Ports:
    * A new makefile variable: //POINTS_TO= wiki.freebsd.org/Ports/category/portname//

===== Wins =====

  * The release engineering team has a list of undocumented features before a release