Error in the comment for wxfilename and rxfilename

[csukuangfj]

See the comment below

kaldi/src/util/kaldi-io.h

Lines 55 to 72 in 0cc941f

	// We now document the types of extended filenames that we use.
	//
	// A "wxfilename" is an extended filename for writing. It can take three forms:
	// (1) Filename: e.g. "/some/filename", "./a/b/c", "c:\Users\dpovey\My
	// Documents\\boo"
	// (whatever the actual file-system interprets)
	// (2) Standard output: "" or "-"
	// (3) A pipe: e.g. "gunzip -c /tmp/abc.gz |"
	//
	//
	// A "rxfilename" is an extended filename for reading. It can take four forms:
	// (1) An actual filename, whatever the file-system can read, e.g. "/my/file".
	// (2) Standard input: "" or "-"
	// (3) A pipe: e.g. "| gzip -c > /tmp/abc.gz"
	// (4) An offset into a file, e.g.: "/mnt/blah/data/1.ark:24871"
	// [these are created by the Table and TableWriter classes; I may also write
	// a program that creates them for arbitrary files]
	//

For the wxfilename

(3) A pipe: e.g. "gunzip -c /tmp/abc.gz |"

which is actually an rxfilename.

For the rxfilename

(3) A pipe: e.g. "| gzip -c > /tmp/abc.gz"

which is a wxfilename.

[danpovey]

Yes you're right. Please make a PR to fix this along with the other small errors you noticed.

[csukuangfj]

In addition, the following lists some misleading names in the source code:

---

kaldi/src/util/kaldi-table.cc

Lines 225 to 227 in 0cc941f

	RspecifierType ClassifyRspecifier(const std::string &rspecifier,
	std::string *wxfilename,
	RspecifierOptions *opts) {

std::string *wxfilename, should be std::string *rxfilename,

---

kaldi/src/util/kaldi-table-test.cc

Lines 91 to 93 in 0cc941f

	void UnitTestClassifyWspecifier() {
	{
	std::string a = "b,ark:foo|";

Even though ClassifyWspecifier does not check the validity of the string foo|, it is misleading to use an rxfilename here to demonstrate ClassifyWspecifier

[danpovey]

That's right, thanks. Rather than making an issue for each one, I suggest you accumulate them and make a PR with the fixes in one batch, which I can review.

…

On Wed, Apr 24, 2019 at 11:28 PM csukuangfj ***@***.***> wrote: In addition, the following lists some misleading names in the source code: ------------------------------ https://github.com/kaldi-asr/kaldi/blob/0cc941f7e5fd519a9ffba8c85adafee6d7db0b83/src/util/kaldi-table.cc#L225-L227 std::string *wxfilename, should be std::string *rxfilename, ------------------------------ https://github.com/kaldi-asr/kaldi/blob/0cc941f7e5fd519a9ffba8c85adafee6d7db0b83/src/util/kaldi-table-test.cc#L91-L93 Even though ClassifyWspecifier does not check the validity of the string foo|, it is misleading to use an rxfilename here to demonstrate ClassifyWspecifier — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#3264 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAZFLO6XQ56DGQQK4KGS7ALPSEQOLANCNFSM4HIJFR3A> .

[csukuangfj]

@danpovey
fixed in #3153