[gdal-dev] About -oo -lco -dsco in docs

[Thomas Gratier]

Hi,

There are implicit rules when you read the OGR/GDAL docs in fact, in
particular when you use `ogr2ogr` or `ogrinfo`

`-oo <NAME>=<VALUE>` like "Open Options"
`-lco <NAME>=<VALUE>` for "Layer Creation Option"
`-dsco <NAME>=<VALUE>` for "DataSet Creation Option"

So, when you read for instance https://gdal.org/drivers/vector/csv.html,
you will see there is a section "Open options" so you will know that you
can use `-oo`. Also, you will see a "Layer Creation options" block so
again, you will know it mean use `-lco`.

It's documented in "ogr2ogr" but you need to know the rule to make the link
in your mind when reading the doc. Any idea to clarify the doc about the
"tip".

An idea could be about adding in drivers docs "Open options" block a
sentence like "When using the command line, use the flag `-oo
<NAME>=<VALUE>`" and do the same for "Layer creation options" block "When
using the command line, use the flag `-lco <NAME>=<VALUE>`"

Thoughts about the suggestion? Better idea? Not worth?

Regards,

Thomas Gratier
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/gdal-dev/attachments/20240326/245cf47f/attachment.htm>