On Sat, Dec 17, 2022 at 7:45 PM Michael Kerrisk (man7.org) <m...@man7.org> wrote:
> Hello Flavio, > > Hello Michael, This looks great to me. Let's see if anyone else in ovs-discuss has anything to add, but I'm psyched about the update. A gift just in time for the holidays! :) Thank you so much for doing this. Best, -- flaviof > After a long delay, I've updated the pages. See > > https://man7.org/linux/man-pages/dir_by_project.html#Open%20Virtual%20Network > and > https://man7.org/linux/man-pages/dir_by_project.html#Open%20vSwitch > > Does everything look okay? > > Thanks, > > Michael > > On Fri, 17 Sept 2021 at 10:42, Flavio Fernandes <flav...@redhat.com> > wrote: > > > > > > > > On Thu, Sep 2, 2021 at 1:40 AM Michael Kerrisk <m...@man7.org> wrote: > >> > >> Hello Flavio, > >> > >> On 4/28/21 5:20 PM, Flavio Fernandes wrote: > >> > [cc Mark, OVN discuss] > >> > > >> > Hello Michael, > >> > > >> > I've recently done some work on automating the man pages for ovn.org > [0] > >> > and would like to see if man7.org could be updated to pick up a more > recent > >> > content of that. > >> > >> Yes, I'm willing (late reply notwithstanding), but see below... > > > > > > Awesome! > > > > > >> > >> > >> Based on the link from blog.man7.org [1], here is some > >> > info on OVN. Since that page was written in 2014, I wonder if that is > still > >> > valid. Please let me know if I looked at the wrong place.> > >> > OVN was split out of the Openvswitch repo in 2019 via [2], but we > still > >> > share the same mailing lists. It is likely that the content related > to OVN > >> > is in man7.org while it was part of OVS still. That said, OVS man > pages may > >> > also need an update, right? > >> > > >> > * Name of the project. > >> > > >> > Open Virtual Network > >> > > >> > * Project description. > >> > > >> > OVN (Open Virtual Network) is a series of daemons for the Open > vSwitch that > >> > translate virtual network configurations into OpenFlow. > >> > > >> > * URL for the web site the project. > >> > > >> > https://www.ovn.org/en/ > >> > > >> > (If you know it:) URL of a web page that provides information on how > to > >> > report bugs in the man pages (or email list address). > >> > > >> > https://www.ovn.org/en/contributing/ > >> > > >> > * Source URL for the man pages of the project. The project should > provide > >> > pages by one of the following means one of the following: > >> > > >> > Ideally: the URL of a Git repository for the project. > >> > > >> > https://github.com/ovn-org/ovn > >> > Info on releases is available here: > >> > https://www.ovn.org/en/releases/ > >> > > >> > * Instructions on how to build the man pages for the project. These > >> > instructions should be minimal, in the sense that they require the > minimum > >> > CPU effort to build just the man pages. In other words, if possible, > I'd > >> > like to avoid building the entire project just to obtain the manual > pages. > >> > > >> > To build the man pages, follow (or run) the github workflow [3]. > >> > >> Sorry, but I don't have the time to work this out. Would it be possible > >> to please just send me the command line instructions that I should use > >> to build the pages once I have cloned the repo? > > > > > > No problem. I will paste the steps below [stepsForGettingDocs]. > > > >> > >> > >> > As you can see in [0]. The built docs are stored under > >> > > >> > > https://github.com/ovn-org/ovn-website/tree/master/src/static/support/ > >> > > >> > https://www.ovn.org/support/dist-docs/ <-- latest, master branch > >> > src/static/support/dist-docs-branch-21.03/ <-- branch-21.03 > >> > > >> > * Approximate number of manual pages in the project (actual pages, > >> > excluding links). > >> > > >> > ~/work/ovn-website.git/src/static/support/dist-docs > >> > $ find . -name "*.html" | wc -l > >> > 18 > >> > >> Do the build instructions produce man source files? (I can't > >> use HTML files as input.) > > > > > > Absolutely. These are the types generated: PDF, HTML, plain text > > > > Here is an example link that gives you an idea of what they look like: > > > > https://www.ovn.org/support/dist-docs/ > > > > Thank you! > > > > -- flaviof > > > > [stepsForGettingDocs]: > https://gist.github.com/flavio-fernandes/eba4b360e7be22e47a0d0563c6533b88 > > > > inline > > # docker run -i --tty --rm --net=host --name=ubuntu ubuntu:18.04 > > > > DEPS='git automake libtool gcc bc libjemalloc1 libjemalloc-dev > > libssl-dev llvm-dev libelf-dev libnuma-dev libpcap-dev > > selinux-policy-dev > > libunbound-dev libunwind-dev > > python3 python3-pip man > > ghostscript markdown' > > > > apt update > > apt install -y $DEPS > > pip3 install --upgrade pip > > export PATH="${PATH}:${HOME}/bin:${HOME}/.local/bin" > > > > git clone https://github.com/ovn-org/ovn.git > > > > pushd ./ovn > > git submodule update --init > > ./.ci/linux-prepare.sh > > ./.ci/linux-build.sh > > make dist-docs > > popd > > > > ls -l ./ovn/dist-docs > > > > > > > > > > > >> > >> > [0]: > >> > > https://github.com/ovn-org/ovn-website/commit/84a6d0556f9325c5a613b4e47bb3da1fd1240a2e > >> > > >> > [1]: > http://blog.man7.org/2013/05/adding-further-man-pages-to-html.html > >> > > >> > [2]: > >> > > https://github.com/openvswitch/ovs/commit/f3e24610ea18eb873dc860f1710432e9aacd27fd > >> > > >> > [3]: > >> > > https://github.com/ovn-org/ovn-website/blob/master/.github/workflows/dist-docs.yml > >> > >> Thanks, > >> > >> Michael > >> > >> > >> -- > >> Michael Kerrisk, man7.org Training and Consulting > >> m...@man7.org, http://man7.org/training/ > >> "The Linux Programming Interface" -- http://man7.org/tlpi/ > >> > > > -- > Michael Kerrisk, man7.org Training and Consulting > m...@man7.org, http://man7.org/training/ > "The Linux Programming Interface" -- http://man7.org/tlpi/ > >
_______________________________________________ discuss mailing list disc...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-discuss
