Page MenuHomeFreeBSD

tcsh(1): Fix typo in manual page
AbandonedPublic

Authored by otis on Oct 11 2022, 8:12 PM.
Tags
None
Referenced Files
Unknown Object (File)
Wed, Jun 26, 11:46 PM
Unknown Object (File)
Mon, Jun 24, 3:18 PM
Unknown Object (File)
May 22 2024, 3:39 AM
Unknown Object (File)
May 18 2024, 6:52 AM
Unknown Object (File)
May 17 2024, 3:02 PM
Unknown Object (File)
Dec 23 2023, 1:16 AM
Unknown Object (File)
Jul 1 2023, 3:38 AM
Unknown Object (File)
May 9 2023, 2:52 AM

Details

Reviewers
imp
Group Reviewers
manpages
Summary

Fix "iff" -> "if"

Diff Detail

Repository
rG FreeBSD src repository
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 47784
Build 44671: arc lint + arc unit

Event Timeline

otis requested review of this revision.Oct 11 2022, 8:12 PM
pauamma_gundo.com added inline comments.
contrib/tcsh/tcsh.man
3877

I vaguely remember that "iff" means "if and only if". Could that be the case here? (If so, it should be reworded to avoid the confusing shortcut.)

imp requested changes to this revision.Oct 12 2022, 2:24 AM

iff is If and Only If, and is correct here.
I think this is a bad change

This revision now requires changes to proceed.Oct 12 2022, 2:24 AM
In D36942#839083, @imp wrote:

iff is If and Only If, and is correct here.
I think this is a bad change

Now it's obvious that for non-native English speaker this may be a "trap".

In D36942#839097, @otis wrote:
In D36942#839083, @imp wrote:

iff is If and Only If, and is correct here.
I think this is a bad change

Now it's obvious that for non-native English speaker this may be a "trap".

I was coming to mention that. For one who reported it, there are probably dozens who just thought it was "if". I recommend

Has an effect if 'dspm' is listed as part of the \fBversion\fR shell variable and only then.

instead. Do you want to change it to that, or should I?

In D36942#839130, @pauamma wrote:
In D36942#839097, @otis wrote:
In D36942#839083, @imp wrote:

iff is If and Only If, and is correct here.
I think this is a bad change

Now it's obvious that for non-native English speaker this may be a "trap".

I was coming to mention that. For one who reported it, there are probably dozens who just thought it was "if". I recommend

Has an effect if 'dspm' is listed as part of the \fBversion\fR shell variable and only then.

instead. Do you want to change it to that, or should I?

Please don't. It's contrib and it's a well established convention. If you want to change it, please change it upstream.

In D36942#839197, @imp wrote:
In D36942#839130, @pauamma wrote:
In D36942#839097, @otis wrote:
In D36942#839083, @imp wrote:

iff is If and Only If, and is correct here.
I think this is a bad change

Now it's obvious that for non-native English speaker this may be a "trap".

I was coming to mention that. For one who reported it, there are probably dozens who just thought it was "if". I recommend

Has an effect if 'dspm' is listed as part of the \fBversion\fR shell variable and only then.

instead. Do you want to change it to that, or should I?

Please don't. It's contrib and it's a well established convention. If you want to change it, please change it upstream.

Fair enough, but now I'm confused. Since you only bring that up now, does that mean that some doc differences from upstream are OK and others aren't? Or am I reading too much in the time you brought this up?

In D36942#839356, @pauamma wrote:

Fair enough, but now I'm confused. Since you only bring that up now, does that mean that some doc differences from upstream are OK and others aren't? Or am I reading too much in the time you brought this up?

For files under src/contrib/, we have an upstream for them. We strive to keep the differences to a minimum or zero, which means we prefer, where possible, to have the differences submitted upstream first and brought in that way so that future imports don't generate merge conflicts. That's not always possible, or the process may be delayed in some cases, and then it's OK.

For tcsh, we get it from NetBSD, and they have been quite responsive in the past to bug fixes, etc. christos@NetBSD.org or dholland@NetBSD.org are good people to send a patch to and see what they say. Once it's in NetBSD, let me know and I'll start the update process.

In D36942#839373, @imp wrote:

For tcsh, we get it from NetBSD, and they have been quite responsive in the past to bug fixes, etc. christos@NetBSD.org or dholland@NetBSD.org are good people to send a patch to and see what they say. Once it's in NetBSD, let me know and I'll start the update process.

Should I tell them you sent me? (And if so, what name/handle do you use with them?)