Building (deleted) Waterfox 56.2.8: error: missing documentation for macro

[Jan Beich]

Graham Perrin <grahamperrin at gmail.com> writes:

> On 17/03/2019 19:54, Charlie Li wrote:
>
>> On 17/03/2019 12:25, Jan Beich wrote:
>>
>>> …
>>>
>>> Looks like a regression from Rust 1.33 update.
>>>
>>> Either remove missing_docs from #![deny(...)] lines (or lines 
> themselves)
>>> for each one that triggers error (no need to bother with unused ones) or
>>> add MOZ_OPTIONS+=--disable-stylo to Makefile.local.
>>>
>>> …
>>
>> I simply followed the tip given in Mozilla bug 1521249 (remove
>> `#![deny(missing_docs)]`), and have been running with it since we
>> updated our lang/rust to 1.33:
>> https://bugzilla.mozilla.org/show_bug.cgi?id=1521249#c36
>>

#![deny(missing_docs)] should probably be killed in favor of -Dwarnings
after https://bugzilla.mozilla.org/show_bug.cgi?id=1513009

It's usually a waste of time to fix doc-related warnigs on release branches.
Rust compiler upgrades just make this more obvious.

>
> Thank you both.
>
> In my fork: <https://github.com/grahamperrin/Waterfox/pull/7/files> –
> at a glance, does that look OK?
>
> I'm unsure about
> <https://github.com/grahamperrin/Waterfox/pull/7/files#diff-df8dc4c48927e0bc43931d04bb5b9d9aR161>,
> should that line be left as was?
>
>  #[deny(missing_docs)]
>
> (No exclamation mark.)

If the line doesn't break build, leave it as is.
See also https://doc.rust-lang.org/reference/attributes.html

In general, try to document error you're fixing or working around in the
commit message as the rationale. And discussions like this one are only
useful to reference as meta information in PR description, not in commits.