pkgsrc-WIP-changes archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
Re: dfu-discovery: Add arduino-dfu-discovery-0.1.2 Arduino pluggable discovery for dfu devices
On Tue, Feb 13, 2024 at 08:47:17AM -0500, Greg Troxel wrote:
> Rui-Xiang Guo <rxg%lavabit.com@localhost> writes:
>
> > diff --git a/arduino-dfu-discovery/DESCR b/arduino-dfu-discovery/DESCR
> > new file mode 100644
> > index 0000000000..edc869a48d
> > --- /dev/null
> > +++ b/arduino-dfu-discovery/DESCR
> > @@ -0,0 +1,3 @@
> > +The dfu-discovery tool is a command line program that interacts via stdio.
> > +It accepts commands as plain ASCII strings terminated with LF \n and sends
> > +response as JSON.
>
> Could you improve DESCR so that someone (who understands computers and
> software, and knows what Arduino is) can understand what this program
> actually does and is useful for? I for example don't know what "dfu"
> means (yes, I could search), and I don't know what kind of information
> is in commands and responses, or what the point is.
DESCRs are revised. The original descriptions are just fetched from their
README on GitHub. These pluggable tools are only useful for arduino-cli on
non-official supported OSes.
> To me, the fact that responses are in json is a detail that likely
> doesn't matter. The important thing is the high-level point of the
> protocol.
>
> Generally, the idea of DESCR is to have enough information while still
> being concise, so that someone can read it and sort the package into
> "this might solve my problem and I should read the docs" vs "this is not
> what I want", keeping in mind there are 1000s of "not what I want".
Home |
Main Index |
Thread Index |
Old Index