Page MenuHomeFreeBSD

address bug 207026 - add dma(8) to examples in mailer.conf(5)
ClosedPublic

Authored by jgh on Feb 12 2016, 12:49 AM.

Details

Diff Detail

Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

jgh retitled this revision from to address bug 207026 - add dma(8) to examples in mailer.conf(5).
jgh updated this object.
jgh edited the test plan for this revision. (Show Details)
jgh added reviewers: wblock, bcr, remko.
jgh set the repository for this revision to rD FreeBSD doc repository - subversion.
.Xr dma 8``` should be added to the See Also list, too.

This should not be MFCed, since 10-stable does not have dma.
share/man/man5/mailer.conf.5
145

This is probably better like the comment, "instead of". I suspect that is more common and easier for translators.
...Ah, I see that the other examples use "in place of". Well, no time like the present to break with tradition.

This could be MFC'd with /usr/local/libexec/dma in place of /usr/libexec/dma (as we have mail/dma package).
It's not a big deal if it's mot MFC'd at all though.

lifanov_mail.lifanov.com edited edge metadata.

address comments by wblock: replace "in place of" with "instead of"

I didn't mean to change all of them, but see no problem with that.

Still need to add .Xr dma 8 to the See Also section.

lifanov_mail.lifanov.com edited edge metadata.

add dma(8) to .Xr

mandoc -Tlint (PASS)

I thought I would be addressing this, but looks like others are now looking into it, as well? I'm not sure what the status of this is now....

Please commandeer this. I'm the reporter from Bugzilla and I had spare cycles to address feedback over the weekend.

jgh edited reviewers, added: lifanov_mail.lifanov.com; removed: jgh.

It also seems odd to me that we are mentioning the "package from ports"... ports are not packages, and packages are not ports, but you need ports to make packages :)

How about just ommitting the word "package". This becomes "This example shows the use of the mini_sendmail from ports instead of sendmail".

This can be addressed with other content update, in my opinion. I would like to change the wording of the new content, but then go back and address other content.

jgh updated this object.
jgh edited edge metadata.
jgh removed rS FreeBSD src repository - subversion as the repository for this revision.

address comments

Since the working is being discussed, I chose a different path as I felt the statement was rather wordy. I attempted to tighten it.

If it's okay with wblock, it's okay with me. I don't have good grasp on language.

I think "instead of" is more commonly-used than "in place of", but don't have any strong objections.

share/man/man5/mailer.conf.5
145

"in favor of" usually means the second thing is better than/preferred to/replacing the first. It is kind of confusing here.

Sometimes difficulty in simplifying a sentence means that it is trying to say to much or working too hard to get there.
What about changing this to be more direct than the original man page wording, like so:

This example shows how to use
.Xr dma 8
as a replacement for
.Xr sendmail 8 :

That could be even simpler:

Using
.Xr dma 8
to replace
.Xr sendmail 8 :
This revision is now accepted and ready to land.Feb 18 2016, 10:34 PM
This revision was automatically updated to reflect the committed changes.