Skip to content

Commit

Permalink
Reformat markdown according to latest pandoc
Browse files Browse the repository at this point in the history
  • Loading branch information
khenriks committed Jun 13, 2021
1 parent 68b7193 commit 55aa6f5
Show file tree
Hide file tree
Showing 6 changed files with 75 additions and 82 deletions.
16 changes: 8 additions & 8 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

mp3fs requires the following libraries:

- fuse (\>= 2.6.0)
- flac++ (\>= 1.1.4)
- libvorbis (\>= 1.3.0)
- lame
- libid3tag
- fuse (>= 2.6.0)
- flac++ (>= 1.1.4)
- libvorbis (>= 1.3.0)
- lame
- libid3tag

If building from git, you'll also need:

- autoconf
- automake
- pandoc
- autoconf
- automake
- pandoc

The commands to install the prerequisites follow.

Expand Down
6 changes: 2 additions & 4 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,12 @@ faststaticcheck:
@statictest/checkall fast

# The special logic for mp3fs.1.md is because it needs certain features for
# manpage output. The weird sed logic is there to preserve '.\ ' sequences,
# and the check is made automatically passing because the headers aren't
# preserved properly.
# manpage output. The weird sed logic is there to preserve '.\ ' sequences.
mdcheck:
@set -e ; for f in *.md */*.md ; do \
echo "Checking format for $$f." ; \
if [ "$$f" = mp3fs.1.md ] ; then \
sed 's/\.\\/!./g' "$$f" | pandoc -d .pandocfmt.yaml -f markdown -t markdown | sed 's/!\./.\\/g' | diff -u $$f - || : ; \
sed 's/\.\\/!./g' "$$f" | pandoc -d .pandocfmt.yaml -f markdown -t markdown | sed 's/!\./.\\/g' | diff -u $$f - ; \
else \
pandoc -d .pandocfmt.yaml "$$f" | diff -u "$$f" - ; \
fi ; \
Expand Down
72 changes: 36 additions & 36 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,71 +11,71 @@ This contains various bug fixes, mostly.

Fixes/improvements:

- Recognize upper/mixed case in input filenames
- Fix file size handling with and without cache
- Various code simplifications/cleanup
- Recognize upper/mixed case in input filenames
- Fix file size handling with and without cache
- Various code simplifications/cleanup

New features:

- Log lines now include thread ID and can be customized.
- Log lines now include thread ID and can be customized.

## Important changes in 1.0 (2020-05-24)

mp3fs 1.0 is finally here\!
mp3fs 1.0 is finally here!

Fixes/code improvements:

- Many, many bug fixes (buffer overflows, memory leaks, and others)
- Memory handling improvements (using RAII with C++ nearly everywhere)
- Adopting C++11 and modernizing code
- Static tests for code (e.g. clang-format, clang-tidy, IWYU)
- Many, many bug fixes (buffer overflows, memory leaks, and others)
- Memory handling improvements (using RAII with C++ nearly everywhere)
- Adopting C++11 and modernizing code
- Static tests for code (e.g. clang-format, clang-tidy, IWYU)

New features:

- Ogg Vorbis decoding support
- MP3 VBR encoding support
- Improved, much more customizable logging
- Ogg Vorbis decoding support
- MP3 VBR encoding support
- Improved, much more customizable logging

Other:

- Docs licensed under GPL 3+ (now entire codebase is distributable as GPL 3)
- All docs switched to Markdown (including manpage, using pandoc)
- Docker image now available
- Docs licensed under GPL 3+ (now entire codebase is distributable as GPL 3)
- All docs switched to Markdown (including manpage, using pandoc)
- Docker image now available

## Important changes in 0.91 (2014-05-14)

This contains mainly bug fixes.

Changes in this release:

- Fixed a segfault caused by an overflow reading the list of available
- Fixed a segfault caused by an overflow reading the list of available
decoders.
- A number of problems with the previous distribution tar are now fixed.
- The output of `mp3fs --version` has been made more complete.
- A number of problems with the previous distribution tar are now fixed.
- The output of `mp3fs --version` has been made more complete.

## Important changes in 0.9 (2014-04-06)

This is a major new release, and brings us very close to a 1.0 release\!
This is a major new release, and brings us very close to a 1.0 release!

Changes in this release:

- All transcoding code has been completely rewritten. Encoding and decoding
- All transcoding code has been completely rewritten. Encoding and decoding
have been abstracted out into base classes defining interfaces that can be
implemented by different codec classes, with just a FLAC decoder and MP3
encoder at the moment.
- The build system has been modified as well to support this usage.
- A number of small bugs or code inefficiencies have been fixed.
- The build system has been modified as well to support this usage.
- A number of small bugs or code inefficiencies have been fixed.

## Important changes in 0.32 (2012-06-18)

This release has a lot of bug fixes and some code cleanup.

Changes in this release:

- The file size calculation should always be correct.
- A crash affecting programs like scp that might try to access past the end
- The file size calculation should always be correct.
- A crash affecting programs like scp that might try to access past the end
of the file has been fixed.
- Too many other little fixes were made to list here. See the ChangeLog for
- Too many other little fixes were made to list here. See the ChangeLog for
full details.

## Important changes in 0.31 (2011-12-04)
Expand All @@ -84,11 +84,11 @@ This is a minor update, with bug fixes and a new feature.

Changes in this release:

- The ReplayGain support added earlier now can be configured through the
- The ReplayGain support added earlier now can be configured through the
command line.
- Filename translation (from .flac to .mp3) is now fixed on filesystems such
as XFS that do not populate dirent.d\_type.
- A couple other minor bugs fixes and changes were made.
- Filename translation (from .flac to .mp3) is now fixed on filesystems such
as XFS that do not populate dirent.d_type.
- A couple other minor bugs fixes and changes were made.

## Important changes in 0.30 (2010-12-01)

Expand All @@ -97,17 +97,17 @@ release.

Changes in this release:

- Support for additional metadata tags has been added. (From Gregor Zurowski)
- Documentation improvements: the help message is more useful, and a man page
- Support for additional metadata tags has been added. (From Gregor Zurowski)
- Documentation improvements: the help message is more useful, and a man page
has been added.
- Choosing bitrate is now done with a command-line or mount option, rather
- Choosing bitrate is now done with a command-line or mount option, rather
than the old comma syntax.
- A new option to select LAME encoding quality is now available. (From Gregor
- A new option to select LAME encoding quality is now available. (From Gregor
Zurowski)
- Debug output can be enabled at runtime.
- Old external libraries included in distribution (StringIO, talloc) have
- Debug output can be enabled at runtime.
- Old external libraries included in distribution (StringIO, talloc) have
been removed and replaced.
- Numerous bug fixes have been made. (Some from Gregor Zurowski)
- Numerous bug fixes have been made. (Some from Gregor Zurowski)

...

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@ mp3fs uses Git for revision control. You can obtain the full repository with:

mp3fs is written in a mixture of C and C++ and uses the following libraries:

- [FUSE](http://fuse.sourceforge.net/)
- [FLAC](http://flac.sourceforge.net/)
- [libvorbis](http://www.xiph.org/vorbis/)
- [LAME](http://lame.sourceforge.net/)
- [libid3tag](http://www.underbit.com/products/mad/)
- [FUSE](http://fuse.sourceforge.net/)
- [FLAC](http://flac.sourceforge.net/)
- [libvorbis](http://www.xiph.org/vorbis/)
- [LAME](http://lame.sourceforge.net/)
- [libid3tag](http://www.underbit.com/products/mad/)

## Authors

Expand Down
18 changes: 9 additions & 9 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,24 @@ $ docker run --device /dev/fuse \

There's a lot here, so let's unpack the command.

- `docker run` is how you run a docker container.
- `--device /dev/fuse` is needed to allow FUSE access.
- `--cap-add SYS_ADMIN` is necessary to mount filesystems inside Docker
- `docker run` is how you run a docker container.
- `--device /dev/fuse` is needed to allow FUSE access.
- `--cap-add SYS_ADMIN` is necessary to mount filesystems inside Docker
containers. This might not be needed in the future for FUSE (see
[docker/for-linux\#321](https://github.com/docker/for-linux/issues/321)),
[docker/for-linux#321](https://github.com/docker/for-linux/issues/321)),
but for now it's required.
- `--security-opt apparmor:unconfined` is also needed to mount filesystems
- `--security-opt apparmor:unconfined` is also needed to mount filesystems
inside Docker.
- `-v /home/khenriks/Music:/music:ro` mounts the host directory
- `-v /home/khenriks/Music:/music:ro` mounts the host directory
`/home/khenriks/Music` read-only in the container. This will be the input
for mp3fs. The host directory can be replaced with anything, but `/music`
is required because that's where the container expects it.
- `-v /tmp/mp3:/mnt:shared` mounts the directory `/tmp/mp3` inside the
- `-v /tmp/mp3:/mnt:shared` mounts the directory `/tmp/mp3` inside the
container. This will be the output from mp3fs. Again, the host directory
can be anything, but `/mnt` is required by the container. `shared` makes
the mp3fs mount inside the container show up in the host directory outside.
- `khenriks/mp3fs` is the name of the Docker image.
- `-b 256` is the normal mp3fs flag for bitrate. You can use any mp3fs flags
- `khenriks/mp3fs` is the name of the Docker image.
- `-b 256` is the normal mp3fs flag for bitrate. You can use any mp3fs flags
here, after the image name.

## Docker Compose
Expand Down
35 changes: 15 additions & 20 deletions mp3fs.1.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,25 @@
% MP3FS(1) | User Commands
---
adjusting: l
hyphenate: false
...
title: MP3FS(1) \| User Commands
---

NAME
====
# NAME

mp3fs - mounts and transcodes FLACs and OGGs to MP3s on the fly

SYNOPSIS
========
# SYNOPSIS

**mp3fs** \[*OPTION*\]...\ *IN\_DIR* *OUT\_DIR*
**mp3fs** \[*OPTION*\]...\ *IN_DIR* *OUT_DIR*

DESCRIPTION
===========
# DESCRIPTION

The mp3fs(1) command will mount the directory *IN\_DIR* on *OUT\_DIR*.
Thereafter, accessing *OUT\_DIR* will show the contents of *IN\_DIR*, with all
The mp3fs(1) command will mount the directory *IN_DIR* on *OUT_DIR*.
Thereafter, accessing *OUT_DIR* will show the contents of *IN_DIR*, with all
FLAC/Ogg Vorbis files transparently renamed and transcoded to MP3 format upon
access.

OPTIONS
=======
# OPTIONS

**-b, -obitrate**=*RATE*

Expand Down Expand Up @@ -73,7 +69,7 @@ OPTIONS

: Print usage information.

**--log\_format, -olog\_format**=*FORMAT*
**--log_format, -olog_format**=*FORMAT*

: Specify the format to use for log messages, with the following
substitutions:
Expand All @@ -86,19 +82,19 @@ OPTIONS

%T - time, formatted as YYYY-MM-DD HH:MM:SS

The default is "[%T] tid=%I %L: %M".
The default is "\[%T\] tid=%I %L: %M".

**--log\_maxlevel, -olog\_maxlevel**=*LEVEL*
**--log_maxlevel, -olog_maxlevel**=*LEVEL*

: Set the maximum level of messages to log, either ERROR, INFO, or DEBUG.
Defaults to INFO, and forced to DEBUG in debug mode. Note that this does
not enable logging; other log flags must be set to specify where to log.

**--log\_stderr, -olog\_stderr**
**--log_stderr, -olog_stderr**

: Output logging messages to stderr. Enabled in debug mode.

**--log\_syslog, -olog\_syslog**
**--log_syslog, -olog_syslog**

: Output logging messages to the system log.

Expand Down Expand Up @@ -132,8 +128,7 @@ OPTIONS

: Output version information.

COPYRIGHT
=========
# COPYRIGHT

Copyright (C) 2006-2008 David Collett and 2008-2013 K.\ Henriksson. This is
free software: you are free to change and redistribute it under the terms of
Expand Down

0 comments on commit 55aa6f5

Please sign in to comment.