15 Oct, 2020
2 commits
-
Those macros are not doing the right thing with Sphinx 3,
causing parse errors:./Documentation/driver-api/fpga/fpga-mgr.rst:104: WARNING: Unparseable C cross-reference: 'fpga_manager->state'
Invalid C declaration: Expected end of definition. [error at 12]
fpga_manager->state
------------^
./Documentation/driver-api/fpga/fpga-programming.rst:18: WARNING: Unparseable C cross-reference: 'fpga_region->info'
Invalid C declaration: Expected end of definition. [error at 11]
fpga_region->info
-----------^
./Documentation/driver-api/fpga/fpga-region.rst:62: WARNING: Unparseable C cross-reference: 'fpga_region->bridge_list'
Invalid C declaration: Expected end of definition. [error at 11]
fpga_region->bridge_list
-----------^
./Documentation/driver-api/fpga/fpga-region.rst:62: WARNING: Unparseable C cross-reference: 'fpga_region->get_bridges'
Invalid C declaration: Expected end of definition. [error at 11]
fpga_region->get_bridges
-----------^Replace them by :c:expr:, with does what's desired.
Reviewed-by: Moritz Fischer
Signed-off-by: Mauro Carvalho Chehab -
The :c:type:`foo` only works properly with structs before
Sphinx 3.x.On Sphinx 3.x, structs should now be declared using the
.. c:struct, and referenced via :c:struct tag.As we now have the automarkup.py macro, that automatically
convert:
struct foointo cross-references, let's get rid of that, solving
several warnings when building docs with Sphinx 3.x.Reviewed-by: André Almeida # blk-mq.rst
Reviewed-by: Takashi Iwai # sound
Reviewed-by: Mike Rapoport
Reviewed-by: Greg Kroah-Hartman
Signed-off-by: Mauro Carvalho Chehab
25 Aug, 2020
1 commit
-
Replace :c:func: with func() as the previous usage is deprecated.
Signed-off-by: Puranjay Mohan
Link: https://lore.kernel.org/r/20200812180224.24810-1-puranjay12@gmail.com
Signed-off-by: Jonathan Corbet
16 Oct, 2018
4 commits
-
Clarify the intention that interfaces and upper layers use
regions rather than managers directly.Rearrange API documentation to better group the API functions
used to create FPGA mgr/bridge/regions and the API used for
programming FPGAs.Signed-off-by: Alan Tull
Suggested-by: Federico Vaga
Acked-by: Moritz Fischer
Signed-off-by: Greg Kroah-Hartman -
Add devm_fpga_region_create() which is the
managed version of fpga_region_create().Change current region drivers to use
devm_fpga_region_create().Signed-off-by: Alan Tull
Suggested-by: Federico Vaga
Acked-by: Moritz Fischer
Signed-off-by: Greg Kroah-Hartman -
Add devm_fpga_bridge_create() which is the managed
version of fpga_bridge_create().Change current bridge drivers to use
devm_fpga_bridge_create().Signed-off-by: Alan Tull
Suggested-by: Federico Vaga
Acked-by: Moritz Fischer
Signed-off-by: Greg Kroah-Hartman -
Add devm_fpga_mgr_create() which is the managed
version of fpga_mgr_create().Change current FPGA manager drivers to use
devm_fpga_mgr_create()Signed-off-by: Alan Tull
Suggested-by: Federico Vaga
Acked-by: Moritz Fischer
Signed-off-by: Greg Kroah-Hartman
30 Sep, 2018
1 commit
-
Add flags #defines to kerneldoc documentation in a
useful place.Signed-off-by: Alan Tull
Acked-by: Moritz Fischer
Signed-off-by: Greg Kroah-Hartman
07 Jul, 2018
1 commit
-
Minor fixes including:
* fix some typos
* correct use of a/an
* rephrase explanation of .state ops function
* s/re-use/reuse/ (use only one spelling of 'reuse' in these docs)
* s/cpu/CPU/Signed-off-by: Alan Tull
Acked-by: Randy Dunlap
Signed-off-by: Greg Kroah-Hartman
26 May, 2018
4 commits
-
Move Documentation/fpga/fpga-region.txt to
driver-api/fpga/fpga-region.rst. Including:
- Add it to driver-api/fpga/index.rst
- Formatting changes to build cleanly as ReST documentation
- Some rewrites for better flow as a ReST doc such as moving
API reference to the end of the doc
- Rewrite API reference section to refer to kernel-doc
documentation in fpga-region.c driver codeSigned-off-by: Alan Tull
Signed-off-by: Greg Kroah-Hartman -
Add a new document to driver-api/fpga that documents the
fpga bridge API and add it to driver-api/fpga/index.rstSigned-off-by: Alan Tull
Signed-off-by: Greg Kroah-Hartman -
Move Documentation/fpga/fpga-mgr.txt to driver-api/fpga/fpga-mgr.rst
and:
- Add to driver-api/fpga/index.rst
- Format changes so documentation builds cleanly.
- Minor rewrites that make the doc flow better as ReST documentation.
- Such as moving API reference to end of doc
- Change API reference section to refer to kernel-doc documentation in
fpga-mgr.c driver code rather than statically defining each function.Signed-off-by: Alan Tull
Signed-off-by: Greg Kroah-Hartman -
Start of moving Documentation/fpga/*.txt to driver-api, including:
- Add new directory driver-api/fpga
- Add new file driver-api/fpga/index.rst
- Add driver-api/fpga to driver-api/index.rst
- Move Documentation/fpga/overview.txt to driver-api/fpga/intro.rst
- Formatting and rewrites so that intro.rst will build cleanly
and form a good introduction to the rest of the docs to be added.Signed-off-by: Alan Tull
Signed-off-by: Greg Kroah-Hartman