Documentation | Draft: Create a Package Manual (!50)

Amar Takhar (@amar) gitlab at rtems.org
Mon Oct 28 08:31:31 UTC 2024




Amar Takhar commented on a discussion on package/libbsd/user/index.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/50#note_113870

 > +application. It describes basic initialization and how to use various features
 > +of LibBSD.
 > +
 > +FIXME: This documentation is still under construction. Contributions are
 > +welcome.
 > +
 > +Basics
 > +------
 > +
 > +There are two basic configuration models:
 > +
 > +1. Using a configuration that is as close as possible to the FreeBSD
 > +   configuration. That usually means that you create a `/etc/rc.conf` and some
 > +   other configuration files. Advantage of this model is that it is simple and
 > +   straightforward. Usually the FreeBSD documentation can be used to find out
 > +   how to configure something. The disadvantage is that the configuration isn't

"isn't" is the contraction he's talking about here so instead of putting `isn't` use `is not`.  Contractions are avoided as it makes the language sound informal.  So outside of direct quotes or something you intend to be informal they should be avoided.

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/50#note_113870
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20241028/1258a9b9/attachment-0001.htm>


More information about the bugs mailing list