From owner-freebsd-gecko@freebsd.org Mon Mar 18 11:16:28 2019 Return-Path: Delivered-To: freebsd-gecko@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id ED653153A782 for ; Mon, 18 Mar 2019 11:16:27 +0000 (UTC) (envelope-from jbeich@freebsd.org) Received: from mailman.ysv.freebsd.org (mailman.ysv.freebsd.org [IPv6:2001:1900:2254:206a::50:5]) by mx1.freebsd.org (Postfix) with ESMTP id 76ED98410A for ; Mon, 18 Mar 2019 11:16:27 +0000 (UTC) (envelope-from jbeich@freebsd.org) Received: by mailman.ysv.freebsd.org (Postfix) id 3AB0B153A780; Mon, 18 Mar 2019 11:16:27 +0000 (UTC) Delivered-To: gecko@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 27CED153A77F for ; Mon, 18 Mar 2019 11:16:27 +0000 (UTC) (envelope-from jbeich@freebsd.org) Received: from freefall.freebsd.org (freefall.freebsd.org [96.47.72.132]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) server-signature RSA-PSS (4096 bits) client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "freefall.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id BE3BE84109; Mon, 18 Mar 2019 11:16:26 +0000 (UTC) (envelope-from jbeich@freebsd.org) Received: by freefall.freebsd.org (Postfix, from userid 1354) id 8FA80155F9; Mon, 18 Mar 2019 11:16:26 +0000 (UTC) From: Jan Beich To: Graham Perrin Cc: Charlie Li , gecko@freebsd.org Subject: Re: Building (deleted) Waterfox 56.2.8: error: missing documentation for macro References: <496db844-cb0b-1b53-b498-beec9324b9c0@gmail.com> <1a8a2cd4-fce2-5dca-ec4a-a417d783f56a@vishwin.info> <340c1855-c3c7-af5d-a375-9e95bd72864f@gmail.com> Date: Mon, 18 Mar 2019 12:16:16 +0100 In-Reply-To: <340c1855-c3c7-af5d-a375-9e95bd72864f@gmail.com> (Graham Perrin's message of "Mon, 18 Mar 2019 08:15:52 +0000") Message-ID: MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Rspamd-Queue-Id: BE3BE84109 X-Spamd-Bar: -- Authentication-Results: mx1.freebsd.org X-Spamd-Result: default: False [-2.89 / 15.00]; local_wl_from(0.00)[freebsd.org]; NEURAL_HAM_MEDIUM(-0.99)[-0.992,0]; NEURAL_HAM_SHORT(-0.90)[-0.900,0]; NEURAL_HAM_LONG(-1.00)[-0.998,0]; TAGGED_RCPT(0.00)[freebsd]; ASN(0.00)[asn:11403, ipnet:96.47.64.0/20, country:US] X-BeenThere: freebsd-gecko@freebsd.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gecko Rendering Engine issues List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 18 Mar 2019 11:16:28 -0000 Graham Perrin writes: > On 17/03/2019 19:54, Charlie Li wrote: > >> On 17/03/2019 12:25, Jan Beich wrote: >> >>> =E2=80=A6 >>> >>> Looks like a regression from Rust 1.33 update. >>> >>> Either remove missing_docs from #![deny(...)] lines (or lines=20 > themselves) >>> for each one that triggers error (no need to bother with unused ones) or >>> add MOZ_OPTIONS+=3D--disable-stylo to Makefile.local. >>> >>> =E2=80=A6 >> >> 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=3D1521249#c36 >> #![deny(missing_docs)] should probably be killed in favor of -Dwarnings after https://bugzilla.mozilla.org/show_bug.cgi?id=3D1513009 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: =E2= =80=93 > at a glance, does that look OK? > > I'm unsure about > , > should that line be left as was? > > =C2=A0#[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.