Re: [dpdk-dev] [PATCH] doc: remove file listings

[Thomas Monjalon <thomas@monjalon.net>]

18/01/2019 10:29, Kovacevic, Marko:
> > > Sorry for not making it clearer,
> > > So if someone was reading it and saw this line
> > >
> > > "The examples directory contains sample applications that show how
> > libraries can be used"
> > >
> > > It would be nice to have a link to the sample applications in the docs
> > > like so, which has all the Info that was deleted.
> > >
> > > "The examples directory contains :doc: ../sample_app_ug/index> that show how libraries can be
> > used."
> > >
> > >
> > > -    examples
> > > -    +-- cmdline            # Example of using the cmdline library
> > > -    +-- exception_path     # Sending packets to and from Linux TAP device
> > > -    +-- helloworld         # Basic Hello World example
> > > -    +-- ip_reassembly      # Example showing IP reassembly
> > > -    +-- ip_fragmentation   # Example showing IPv4 fragmentation
> > > -    +-- ipv4_multicast     # Example showing IPv4 multicast
> > > -    +-- kni                # Kernel NIC Interface (KNI) example
> > > -    +-- l2fwd              # L2 forwarding with and without SR-IOV
> > > -    +-- l3fwd              # L3 forwarding example
> > > -    +-- l3fwd-power        # L3 forwarding example with power management
> > > -    +-- l3fwd-vf           # L3 forwarding example with SR-IOV
> > > -    +-- link_status_interrupt # Link status change interrupt example
> > > -    +-- load_balancer      # Load balancing across multiple cores/sockets
> > > -    +-- multi_process      # Example apps using multiple DPDK processes
> > > -    +-- qos_meter          # QoS metering example
> > > -    +-- qos_sched          # QoS scheduler and dropper example
> > > -    +-- timer              # Example of using librte_timer library
> > > -    +-- vmdq_dcb           # Example of VMDQ and DCB receiving
> > > -    +-- vmdq               # Example of VMDQ receiving
> > > -    +-- vhost              # Example of userspace vhost and switch
> > 
> > We have a full guide about examples:
> > 	http://doc.dpdk.org/guides/sample_app_ug/index.html
> 
> Yes I know but I'm saying since we are removing the list from here would it not 
> Be a good idea to add a link to the sample guides in the line it says
> 
> The examples directory contains sample applications that show how libraries can be used

Yes, good idea.