From: Moritz Fischer <mdf@kernel.org>
To: Alan Tull <atull@kernel.org>
Cc: Moritz Fischer <moritz.fischer.private@gmail.com>,
Jonathan Corbet <corbet@lwn.net>,
Randy Dunlap <rdunlap@infradead.org>,
linux-kernel <linux-kernel@vger.kernel.org>,
linux-fpga@vger.kernel.org,
Linux Doc Mailing List <linux-doc@vger.kernel.org>
Subject: Re: [PATCH v2 3/8] fpga: bridge: add devm_fpga_bridge_create
Date: Thu, 6 Sep 2018 11:19:18 -0700 [thread overview]
Message-ID: <20180906181918.GA20419@archbook> (raw)
In-Reply-To: <CANk1AXQaSLziycCv4X50xufehu7AgV34pxydxs8H14uFREy4YQ@mail.gmail.com>
Hi Alan,
On Wed, Sep 05, 2018 at 10:38:53AM -0500, Alan Tull wrote:
> > > - * fpga_bridge_unregister - unregister and free a fpga bridge
> > > - * @bridge: FPGA bridge struct created by fpga_bridge_create
> > > + * fpga_bridge_unregister - unregister a FPGA bridge
> > > + *
> > > + * @bridge: FPGA bridge struct
> > > + *
> > > + * This function is intended for use in a FPGA bridge driver's remove function.
> > > + * If the bridge was created with devm_fpga_bridge_create(), the bridge struct
> > > + * will be automatically freed. If the bridge was created with
> > > + * fpga_bridge_create(), the caller is responsible for freeing the bridge with
> > > + * fpga_bridge_free().
> >
> > I find the formulation somewhat confusing, since it could be
> > interpreted as if you
> > used the devm_() functions you don't have to call unregister().
>
> Yes I'm being too verbose and it's making things muddled. How about
> if I take out the part that starts with "If bridge was created..."?
> That just leaves "This function is intended for use in a FPGA bridge
> driver's remove function."
Sounds good.
Moritz
next prev parent reply other threads:[~2018-09-06 18:19 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-09-04 21:22 [PATCH v2 0/8] fpga: add devm managed create APIs Alan Tull
2018-09-04 21:22 ` [PATCH v2 1/8] fpga: do not access region struct after fpga_region_unregister Alan Tull
2018-09-04 23:41 ` Moritz Fischer
2018-09-05 15:07 ` Alan Tull
2018-09-04 21:22 ` [PATCH v2 2/8] fpga: mgr: add devm_fpga_mgr_create Alan Tull
2018-09-04 21:22 ` [PATCH v2 3/8] fpga: bridge: add devm_fpga_bridge_create Alan Tull
2018-09-05 15:22 ` Moritz Fischer
2018-09-05 15:38 ` Alan Tull
2018-09-06 18:19 ` Moritz Fischer [this message]
2018-09-06 18:49 ` Alan Tull
2018-09-04 21:22 ` [PATCH v2 4/8] fpga: add devm_fpga_region_create Alan Tull
2018-09-04 21:22 ` [PATCH v2 5/8] dt-bindings: fpga: fix freeze controller compatible in region doc Alan Tull
2018-09-06 18:01 ` Alan Tull
2018-09-04 21:22 ` [PATCH v2 6/8] fpga: bridge: fix obvious function documentation error Alan Tull
2018-09-06 18:43 ` Moritz Fischer
2018-09-06 21:28 ` Alan Tull
2018-09-04 21:22 ` [PATCH v2 7/8] docs: fpga: document fpga manager flags Alan Tull
2018-09-06 18:42 ` Moritz Fischer
2018-09-04 21:22 ` [PATCH v2 8/8] docs: fpga: document programming fpgas using regions Alan Tull
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180906181918.GA20419@archbook \
--to=mdf@kernel.org \
--cc=atull@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fpga@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=moritz.fischer.private@gmail.com \
--cc=rdunlap@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).