Skip to content

Commit e32e2fe

Browse files
danvetbzolnier
authored andcommitted
fbdev: fix modedb docs in fb_find_mode
Fix up the indenting that confused sphinx. To make sure we don't have to make the examples unreadable with escaping just put them in as block quotes, that seems the simplest solution. Signed-off-by: Daniel Vetter <[email protected]> [b.zolnierkie: ported over fbdev changes] Signed-off-by: Bartlomiej Zolnierkiewicz <[email protected]>
1 parent 5c820b8 commit e32e2fe

File tree

1 file changed

+32
-30
lines changed

1 file changed

+32
-30
lines changed

drivers/video/fbdev/core/modedb.c

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -628,45 +628,47 @@ static int fb_try_mode(struct fb_var_screeninfo *var, struct fb_info *info,
628628
}
629629

630630
/**
631-
* fb_find_mode - finds a valid video mode
632-
* @var: frame buffer user defined part of display
633-
* @info: frame buffer info structure
634-
* @mode_option: string video mode to find
635-
* @db: video mode database
636-
* @dbsize: size of @db
637-
* @default_mode: default video mode to fall back to
638-
* @default_bpp: default color depth in bits per pixel
631+
* fb_find_mode - finds a valid video mode
632+
* @var: frame buffer user defined part of display
633+
* @info: frame buffer info structure
634+
* @mode_option: string video mode to find
635+
* @db: video mode database
636+
* @dbsize: size of @db
637+
* @default_mode: default video mode to fall back to
638+
* @default_bpp: default color depth in bits per pixel
639639
*
640-
* Finds a suitable video mode, starting with the specified mode
641-
* in @mode_option with fallback to @default_mode. If
642-
* @default_mode fails, all modes in the video mode database will
643-
* be tried.
640+
* Finds a suitable video mode, starting with the specified mode
641+
* in @mode_option with fallback to @default_mode. If
642+
* @default_mode fails, all modes in the video mode database will
643+
* be tried.
644644
*
645-
* Valid mode specifiers for @mode_option:
645+
* Valid mode specifiers for @mode_option::
646646
*
647-
* <xres>x<yres>[M][R][-<bpp>][@<refresh>][i][p][m] or
648-
* <name>[-<bpp>][@<refresh>]
647+
* <xres>x<yres>[M][R][-<bpp>][@<refresh>][i][p][m]
648+
*
649+
* or ::
649650
*
650-
* with <xres>, <yres>, <bpp> and <refresh> decimal numbers and
651-
* <name> a string.
651+
* <name>[-<bpp>][@<refresh>]
652652
*
653-
* If 'M' is present after yres (and before refresh/bpp if present),
654-
* the function will compute the timings using VESA(tm) Coordinated
655-
* Video Timings (CVT). If 'R' is present after 'M', will compute with
656-
* reduced blanking (for flatpanels). If 'i' or 'p' are present, compute
657-
* interlaced or progressive mode. If 'm' is present, add margins equal
658-
* to 1.8% of xres rounded down to 8 pixels, and 1.8% of yres. The chars
659-
* 'i', 'p' and 'm' must be after 'M' and 'R'. Example:
653+
* with <xres>, <yres>, <bpp> and <refresh> decimal numbers and
654+
* <name> a string.
660655
*
661-
* 1024x768MR-8@60m - Reduced blank with margins at 60Hz.
656+
* If 'M' is present after yres (and before refresh/bpp if present),
657+
* the function will compute the timings using VESA(tm) Coordinated
658+
* Video Timings (CVT). If 'R' is present after 'M', will compute with
659+
* reduced blanking (for flatpanels). If 'i' or 'p' are present, compute
660+
* interlaced or progressive mode. If 'm' is present, add margins equal
661+
* to 1.8% of xres rounded down to 8 pixels, and 1.8% of yres. The char
662+
* 'i', 'p' and 'm' must be after 'M' and 'R'. Example::
662663
*
663-
* NOTE: The passed struct @var is _not_ cleared! This allows you
664-
* to supply values for e.g. the grayscale and accel_flags fields.
664+
* 1024x768MR-8@60m - Reduced blank with margins at 60Hz.
665665
*
666-
* Returns zero for failure, 1 if using specified @mode_option,
667-
* 2 if using specified @mode_option with an ignored refresh rate,
668-
* 3 if default mode is used, 4 if fall back to any valid mode.
666+
* NOTE: The passed struct @var is _not_ cleared! This allows you
667+
* to supply values for e.g. the grayscale and accel_flags fields.
669668
*
669+
* Returns zero for failure, 1 if using specified @mode_option,
670+
* 2 if using specified @mode_option with an ignored refresh rate,
671+
* 3 if default mode is used, 4 if fall back to any valid mode.
670672
*/
671673

672674
int fb_find_mode(struct fb_var_screeninfo *var,

0 commit comments

Comments
 (0)