linux/Documentation/media/uapi/dvb/net-remove-if.rst
Mauro Carvalho Chehab cf8076c314 [media] docs-rst: Convert DVB uAPI to use C function references
Name all ioctl references and make them match the ioctls that
are documented. That will improve the cross-reference index,
as it will have all ioctls and syscalls there.

While here, improve the documentation, marking the deprecated
ioctls, and making the non-deprecated ones more like the rest
of the media book.

Also, add a notice for ioctls that still require documentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-22 21:23:34 -03:00

45 lines
761 B
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _NET_REMOVE_IF:
*******************
ioctl NET_REMOVE_IF
*******************
Name
====
NET_REMOVE_IF - Removes a network interface.
Synopsis
========
.. c:function:: int ioctl( int fd, NET_REMOVE_IF, int ifnum )
:name: NET_REMOVE_IF
Arguments
=========
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``net_if``
number of the interface to be removed
Description
===========
The NET_REMOVE_IF ioctl deletes an interface previously created via
:ref:`NET_ADD_IF <net>`.
Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.