[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v2 3/3] golang/xenlight: add necessary module/package documentation
- To: Nick Rosbrook <rosbrookn@xxxxxxxxx>
- From: George Dunlap <George.Dunlap@xxxxxxxxxx>
- Date: Wed, 13 May 2020 11:29:24 +0000
- Accept-language: en-GB, en-US
- Authentication-results: esa4.hc3370-68.iphmx.com; dkim=none (message not signed) header.i=none; spf=None smtp.pra=George.Dunlap@xxxxxxxxxx; spf=Pass smtp.mailfrom=George.Dunlap@xxxxxxxxxx; spf=None smtp.helo=postmaster@xxxxxxxxxxxxxxx; dmarc=pass (p=none dis=none) d=citrix.com
- Cc: Stefano Stabellini <sstabellini@xxxxxxxxxx>, Julien Grall <julien@xxxxxxx>, Wei Liu <wl@xxxxxxx>, Andrew Cooper <Andrew.Cooper3@xxxxxxxxxx>, Nick Rosbrook <rosbrookn@xxxxxxxxxxxx>, Jan Beulich <jbeulich@xxxxxxxx>, Ian Jackson <Ian.Jackson@xxxxxxxxxx>, xen-devel <xen-devel@xxxxxxxxxxxxxxxxxxxx>
- Delivery-date: Wed, 13 May 2020 11:29:49 +0000
- Ironport-sdr: 7NmjoA4DwNwtjqs0YOc/vZt1BPpyM3OubCTyZaQe6oPDxYZ2NknD24OP5jH93lTiQ/VEjO2qtJ I02IApKsNbsvZBWbg4ZDH2LxqGad/+F+/6EoH9hrrVqQDwbFxkeXk+8004fWK/1Hd/vu21blOx T4IKiANepLXZ5x1EDOfaVc+Zf8/KwO9kFB3t10c/sBLLuDHPEKcwl8TC3K42X4YXiMQ7AEsNWQ w6QG1osp3cNsW16gg9r2dV6kKZR86CpbHWVHKi1+b/EMPsXJQl0UBxuL4D7FQK8Ptx6pOd37Fm EKw=
- List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
- Thread-index: AQHWKMGZFErKT/Po40mgeLsLE6wA6KilwHcA
- Thread-topic: [PATCH v2 3/3] golang/xenlight: add necessary module/package documentation
> On May 13, 2020, at 1:58 AM, Nick Rosbrook <rosbrookn@xxxxxxxxx> wrote:
>
> Add a README and package comment giving a brief overview of the package.
> These also help pkg.go.dev generate better documentation.
One thing I forgot to mention about the README is the long lines — do you mind
if I wrap those before checking it in?
> Also, add a copy of the LGPL (the same license used by libxl) to
> tools/golang/xenlight. This is required for the package to be shown
> on pkg.go.dev and added to the default module proxy, proxy.golang.org.
>
> Finally, add an entry for the xenlight package to SUPPORT.md.
>
> Signed-off-by: Nick Rosbrook <rosbrookn@xxxxxxxxxxxx>
Reviewed-by: George Dunlap <george.dunlap@xxxxxxxxxx>
|