Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug]: Format of podman-network-create manual need an update in the --opt part #17388

Closed
ypu opened this issue Feb 7, 2023 · 5 comments
Closed
Labels
kind/bug Categorizes issue or PR as related to a bug. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments.

Comments

@ypu
Copy link
Contributor

ypu commented Feb 7, 2023

Issue Description

The manual of podman-network-create needs an update in the --option part. Currently the format is a little mess up. We need a new line for options introduce like -mtu, -metric and so on:
` --opt, -o=option
Set driver specific options.

   All drivers accept the mtu and metric options.  - mtu: Sets the Maximum Transmission Unit (MTU) and takes an integer value.  - metric
   Sets  the Route Metric for the default route created in every container joined to this network. Accepts a positive integer value. Can
   only be used with the Netavark network backend.

   Additionally the bridge driver supports the following options: - vlan: This option assign VLAN tag and  enables  vlan_filtering.  De‐
   faults to none.  - isolate: This option isolates networks by blocking traffic between those that have this option enabled.

   The  macvlan  and  ipvlan driver support the following options: - parent: The host device which should be used for the macvlan inter‐
   face. Defaults to the default route interface.  - mode: This option sets the specified ip/macvlan mode on the interface.
     - Supported values for macvlan are bridge, private, vepa, passthru. Defaults to bridge.
     - Supported values for ipvlan are l2, l3, l3s. Defaults to l2.`

Steps to reproduce the issue

Steps to reproduce the issue

  1. man podman-network-create

Describe the results you received

The manual format is a little mess

Describe the results you expected

introductions about the options are start with new line and looks more clearly.

podman info output

compiled podman(HEAD: 67305cec9702977828dc8b3d7e0efd55eec2d909)

Podman in a container

No

Privileged Or Rootless

None

Upstream Latest Release

Yes

Additional environment details

Additional environment details

Additional information

Additional information like issue happens only occasionally or issue happens with a particular architecture or on a particular setting

@ypu ypu added the kind/bug Categorizes issue or PR as related to a bug. label Feb 7, 2023
@baude
Copy link
Member

baude commented Feb 7, 2023

@ypu perhaps you could suggest what you would want to see?

@ypu
Copy link
Contributor Author

ypu commented Feb 7, 2023

Thanks @baude for your advice. Following doc looks more clear for me.

  All drivers accept the mtu and metric options. 
       - mtu: Sets the Maximum Transmission Unit (MTU) and takes an integer value.  
       - metric: Sets  the Route Metric for the default route created in every container joined to this network. Accepts a positive integer value. Can only be used with the Netavark network backend.

   Additionally the bridge driver supports the following options:
     - vlan: This option assign VLAN tag and  enables  vlan_filtering.  Defaults to none. 
     - isolate: This option isolates networks by blocking traffic between those that have this option enabled.

   The  macvlan  and  ipvlan driver support the following options:
      - parent: The host device which should be used for the macvlan interface. Defaults to the default route interface.  
      - mode: This option sets the specified ip/macvlan mode on the interface.
         - Supported values for macvlan are bridge, private, vepa, passthru. Defaults to bridge.
         - Supported values for ipvlan are l2, l3, l3s. Defaults to l2.

@Luap99
Copy link
Member

Luap99 commented Feb 7, 2023

It is correctly rendered in html: https://docs.podman.io/en/latest/markdown/podman-network-create.1.html
So likely the man page converter is failing us here.

@rhatdan
Copy link
Member

rhatdan commented Feb 8, 2023

Yup. I just opened a PR to clean these up. since I saw them while working on quadlet.
#17440

@Luap99
Copy link
Member

Luap99 commented Feb 9, 2023

Thanks @rhatdan, PR is merged so we are good to close.

@Luap99 Luap99 closed this as completed Feb 9, 2023
@github-actions github-actions bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Sep 1, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind/bug Categorizes issue or PR as related to a bug. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments.
Projects
None yet
Development

No branches or pull requests

4 participants